Changeset 200 for trunk


Ignore:
Timestamp:
Apr 28, 2018, 9:03:07 AM (6 years ago)
Author:
g7moreau
Message:
  • Better doc
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/project-meta/project-meta

    r199 r200  
    33# 2018/01/17 Gabriel Moreau <Gabriel.Moreau(A)univ-grenoble-alpes.fr>
    44#
    5 # apt-get install yamllint libyaml-syck-perl libtemplate-perl libarchive-zip-perl
     5# apt-get install libyaml-syck-perl libtemplate-perl libarchive-zip-perl
     6# apt-get install yamllint libyaml-shell-perl # check YAML files
    67
    78use strict;
    89use warnings;
    9 use version; our $VERSION = version->declare('0.0.5');
     10use version; our $VERSION = version->declare('0.0.6');
    1011
    1112use File::Copy qw(copy);   
     
    8990 project-meta remove-link
    9091 project-meta make-zip
     92 project-meta list-licence
     93 project-meta make-licence
    9194 project-meta make-author
    92  project-meta make-licence
    9395 project-meta make-copyright
    94  project-meta make-licence
    95  project-meta list-licence
    9696END
    9797   }
     
    371371 project-meta remove-link
    372372 project-meta make-zip
     373 project-meta list-licence
     374 project-meta make-licence
    373375 project-meta make-author
    374  project-meta make-licence
    375376 project-meta make-copyright
    376  project-meta make-licence
    377  project-meta list-licence
     377
    378378
    379379=head1 DESCRIPTION
     
    386386This YAML file must exist in your root projet folder.
    387387See L</METAFILE SPECIFICATION>.
     388
    388389
    389390=head1 COMMANDS
     
    400401Check your F<PROJECT-META.yml> has the good key.
    401402If your metafile is not a valid YAML file,
    402 you can use C<yamllint> command to check just it's format.
     403you can use C<yamllint> or C<ysh> commands to check just it's format.
    403404
    404405=head2 make-link
     
    453454=back
    454455
     456=head2 list-licence
     457
     458 project-meta list-licence
     459
     460Give the list of all the open data licence supported by the project-meta licence database.
     461At this time the possible licence are:
     462
     463 license-ouverte-v2.0
     464 open-database-license-v1.0
     465
     466Note that these licences are dedicated to open data.
     467Please do not use open licence that have been written for code or documentation for data.
     468
    455469=head2 make-licence
    456470
     
    463477The list of possible licence is given with the command L</list-licence>.
    464478
    465 =head2 list-licence
    466 
    467  project-meta list-licence
    468 
    469 Give the list of all the open data licence supported by the project-meta licence database.
    470 At this time the possible licence are:
    471 
    472  license-ouverte-v2.0
    473  open-database-license-v1.0
    474 
    475 Note that these licences are dedicated to open data.
    476 Please do not use open licence that have been written for code or documentation for data.
    477 
    478479=head2 make-author
    479480
     
    504505 - not really check keys and tags before doing action!
    505506
     507
    506508=head1 SEE ALSO
    507509
    508 yamllint
     510yamllint(1), ysh(1)
     511
     512In Debian, package for C<yamllint> and C<ysh> are
     513
     514=over
     515
     516=item * C<yamllint> - Linter for YAML files (Python)
     517
     518=item * C<libyaml-shell-perl> - YAML test shell (Perl)
     519
     520=back
    509521
    510522
     
    512524
    513525Written by Gabriel Moreau, LEGI UMR5519, CNRS, Grenoble - France
     526
    514527
    515528=head1 SPECIAL THANKS
Note: See TracChangeset for help on using the changeset viewer.