Documented DESCRIPTION file in toolbox skeleton
[scilab.git] / scilab / contrib / xcos_toolbox_skeleton / DESCRIPTION
index 99e45b4..9e0db14 100644 (file)
@@ -1,33 +1,79 @@
-Toolbox: xcos_toolbox_skeleton
+// Modify this file to provide a description of your toolbox.
+// This file is  used by Atoms GUI in scilab, to show information about the toolbox.
+//
+// Note that it will NOT be used when publishing your toolbox on http://atoms.scilab.org;
+// the present file is only used if you distribute your toolbox yourself.
+// On the http://atoms.scilab.org site, only the information you provide there is used.
+//
+//
+// Lines starting with // are comments
+// (you can remove all the comments designed to help you)
+// Lines starting with a space are continuation of the previous field.
+// Empty lines separate fields.
 
-Title: Xcos toolbox skeleton
 
-Summary: Add some blocks to a palette
+// Unique identifier for this toolbox.
+// It must be alphanumeric, start with a letter and contain neither space
+// nor special characters other than underscore or dash.
+Toolbox: toolbox_skeleton
 
-Version: 1.0
+// Human-friendly name for your toolbox
+Title: Toolbox Skeleton
 
-Author: Clément DAVID <clement.david@scilab.org>
+// One-line description for your toolbox
+Summary: Skeleton of a valid atoms package
 
-Maintainer: Clément DAVID <clement.david@scilab.org>
+// Version number, in format 'major.minor.patch', or
+// 'major.minor.patch', where all fields are numbers.
+// If you are just starting your toolbox, you should use '0.1' or '0.1.0'.
+// Use '1.0' or '1.0.0' for a tested, good quality first version.
+Version: 0.1.0
 
+// Name(s) of the author(s) of this toolbox.
+// They are usually the original copyright holders
+// (persons or entities)
+Author: Your Name
+  Other Author
+
+// Name(s) and email address(es) of the person(s) maintaining this toolbox
+Maintainer: Your Name <name@address.com>
+  Other Maintainer <othername@address.com>
+
+// Categories that this toolbox belongs to.
+// The toolbox will appear in the Scilab Atoms GUI
+// under the categories that you select here.
 Category: Xcos
 
-Entity: Digiteo
+// Name of the institution (company, university, lab...) who has developped the toolbox.
+// If you developped the toolbox as an individual, then just enter "private individual"
+Entity: Scilab Enterprises
 
+// Optional website that has more information about this toolbox
 WebSite: http://www.scilab.org
 
-License: CeCILL
+// License under which the toolbox will be published
+License: GPL 2.0
 
-ScilabVersion: >= 5.3
+// Version of Scilab supported by this toolbox,
+// prefixed by =, >= ...
+ScilabVersion: >= 6.0
 
+// Unique identifiers of other toolbox(es) that must be installed in order
+// this toolboxes to work. Atoms will automatically ensure that
+// the dependent toolboxes listed here are installed on the user's
+// Scilab installation.
+// If multiple values, put one per line (starting each line with a space)>
 Depends: 
 
-Date: 2011-03-15
+// Creation date
+Date: 2016-03-01
+
+Description: Succinct presentation of this toolbox.
 
-Description: Example for an Xcos toolbox
- exec builder.sce
- exec loader.sce
- help xcos_toolbox_skeleton 
+ It should cover:
+ - What problem the toolbox solves,
+ - If it requires any third-party software or hardware,
+   and how to install them,
+ - Some basics about how to use it, such as an example of use.
+ but ensuring that each line starts with a space.