Changeset 200 for trunk/project-meta

Timestamp:

Apr 28, 2018, 9:03:07 AM (7 years ago)

Author:

g7moreau

Message:

• Better doc

File:

• trunk/project-meta/project-meta (modified) (9 diffs)

trunk/project-meta/project-meta

@@ -3 +3 @@
 # 2018/01/17 Gabriel Moreau <Gabriel.Moreau(A)univ-grenoble-alpes.fr>
 #
-# apt-get install yamllint libyaml-syck-perl libtemplate-perl libarchive-zip-perl
+# apt-get install libyaml-syck-perl libtemplate-perl libarchive-zip-perl
+# apt-get install yamllint libyaml-shell-perl # check YAML files
 
 use strict;
 use warnings;
-use version; our $VERSION = version->declare('0.0.5');
+use version; our $VERSION = version->declare('0.0.6');
 
 use File::Copy qw(copy);    
@@ -89 +90 @@
  project-meta remove-link
  project-meta make-zip
+ project-meta list-licence
+ project-meta make-licence
  project-meta make-author
- project-meta make-licence
  project-meta make-copyright
- project-meta make-licence
- project-meta list-licence
 END
    }
@@ -371 +371 @@
  project-meta remove-link
  project-meta make-zip
+ project-meta list-licence
+ project-meta make-licence
  project-meta make-author
- project-meta make-licence
  project-meta make-copyright
- project-meta make-licence
- project-meta list-licence
+
 
 =head1 DESCRIPTION
@@ -386 +386 @@
 This YAML file must exist in your root projet folder.
 See L</METAFILE SPECIFICATION>.
+
 
 =head1 COMMANDS
@@ -400 +401 @@
 Check your F<PROJECT-META.yml> has the good key.
 If your metafile is not a valid YAML file,
-you can use C<yamllint> command to check just it's format.
+you can use C<yamllint> or C<ysh> commands to check just it's format.
 
 =head2 make-link
@@ -453 +454 @@
 =back
 
+=head2 list-licence
+
+ project-meta list-licence
+
+Give the list of all the open data licence supported by the project-meta licence database.
+At this time the possible licence are:
+
+ license-ouverte-v2.0
+ open-database-license-v1.0
+
+Note that these licences are dedicated to open data.
+Please do not use open licence that have been written for code or documentation for data.
+
 =head2 make-licence
 
@@ -463 +477 @@
 The list of possible licence is given with the command L</list-licence>.
 
-=head2 list-licence
-
- project-meta list-licence
-
-Give the list of all the open data licence supported by the project-meta licence database.
-At this time the possible licence are:
-
- license-ouverte-v2.0
- open-database-license-v1.0
-
-Note that these licences are dedicated to open data.
-Please do not use open licence that have been written for code or documentation for data.
-
 =head2 make-author
 
@@ -504 +505 @@
  - not really check keys and tags before doing action!
 
+
 =head1 SEE ALSO
 
-yamllint
+yamllint(1), ysh(1)
+
+In Debian, package for C<yamllint> and C<ysh> are
+
+=over
+
+=item * C<yamllint> - Linter for YAML files (Python)
+
+=item * C<libyaml-shell-perl> - YAML test shell (Perl)
+
+=back
 
 
@@ -512 +524 @@
 
 Written by Gabriel Moreau, LEGI UMR5519, CNRS, Grenoble - France
+
 
 =head1 SPECIAL THANKS