Documented DESCRIPTION file in toolbox skeleton
[scilab.git] / scilab / contrib / xcos_toolbox_skeleton / DESCRIPTION
1 // Modify this file to provide a description of your toolbox.
2 // This file is  used by Atoms GUI in scilab, to show information about the toolbox.
3 //
4 // Note that it will NOT be used when publishing your toolbox on http://atoms.scilab.org;
5 // the present file is only used if you distribute your toolbox yourself.
6 // On the http://atoms.scilab.org site, only the information you provide there is used.
7 //
8 //
9 // Lines starting with // are comments
10 // (you can remove all the comments designed to help you)
11 // Lines starting with a space are continuation of the previous field.
12 // Empty lines separate fields.
13
14
15 // Unique identifier for this toolbox.
16 // It must be alphanumeric, start with a letter and contain neither space
17 // nor special characters other than underscore or dash.
18 Toolbox: toolbox_skeleton
19
20 // Human-friendly name for your toolbox
21 Title: Toolbox Skeleton
22
23 // One-line description for your toolbox
24 Summary: Skeleton of a valid atoms package
25
26 // Version number, in format 'major.minor.patch', or
27 // 'major.minor.patch', where all fields are numbers.
28 // If you are just starting your toolbox, you should use '0.1' or '0.1.0'.
29 // Use '1.0' or '1.0.0' for a tested, good quality first version.
30 Version: 0.1.0
31
32 // Name(s) of the author(s) of this toolbox.
33 // They are usually the original copyright holders
34 // (persons or entities)
35 Author: Your Name
36   Other Author
37
38 // Name(s) and email address(es) of the person(s) maintaining this toolbox
39 Maintainer: Your Name <name@address.com>
40   Other Maintainer <othername@address.com>
41
42 // Categories that this toolbox belongs to.
43 // The toolbox will appear in the Scilab Atoms GUI
44 // under the categories that you select here.
45 Category: Xcos
46
47 // Name of the institution (company, university, lab...) who has developped the toolbox.
48 // If you developped the toolbox as an individual, then just enter "private individual"
49 Entity: Scilab Enterprises
50
51 // Optional website that has more information about this toolbox
52 WebSite: http://www.scilab.org
53
54 // License under which the toolbox will be published
55 License: GPL 2.0
56
57 // Version of Scilab supported by this toolbox,
58 // prefixed by =, >= ...
59 ScilabVersion: >= 6.0
60
61 // Unique identifiers of other toolbox(es) that must be installed in order
62 // this toolboxes to work. Atoms will automatically ensure that
63 // the dependent toolboxes listed here are installed on the user's
64 // Scilab installation.
65 // If multiple values, put one per line (starting each line with a space)>
66 Depends: 
67
68 // Creation date
69 Date: 2016-03-01
70
71 Description: Succinct presentation of this toolbox.
72
73  It should cover:
74  - What problem the toolbox solves,
75  - If it requires any third-party software or hardware,
76    and how to install them,
77  - Some basics about how to use it, such as an example of use.
78  but ensuring that each line starts with a space.
79