|
1 | 1 | # META6 |
| 2 | + |
2 | 3 | Do things with Perl 6 [META files](http://design.perl6.org/S22.html#META6.json) |
| 4 | + |
| 5 | +## Synopsis |
| 6 | + |
| 7 | +The below will generate the *META.info* for this module. |
| 8 | + |
| 9 | +``` |
| 10 | +use META6; |
| 11 | +
|
| 12 | +my $m = META6.new( name => 'META6', |
| 13 | + description => 'Work with Perl 6 META files', |
| 14 | + version => Version.new('0.0.1'), |
| 15 | + perl => Version.new('6'), |
| 16 | + depends => <JSON::Class>, |
| 17 | + test-depends => <Test>, |
| 18 | + tags => <devel meta utils>, |
| 19 | + authors => ['Jonathan Stowe <jns+git@gellyfish.co.uk>'], |
| 20 | + auth => 'github:jonathanstowe', |
| 21 | + source-url => 'git://github.com/jonathanstowe/META6.git', |
| 22 | + support => META6::Support.new( |
| 23 | + source => 'git://github.com/jonathanstowe/META6.git' |
| 24 | + ), |
| 25 | + provides => { |
| 26 | + META6 => 'lib/META6.pm', |
| 27 | + }, |
| 28 | + license => 'Artistic', |
| 29 | + production => False, |
| 30 | +
|
| 31 | + ); |
| 32 | +
|
| 33 | +print $m.to-json; |
| 34 | +
|
| 35 | +``` |
| 36 | +## Description |
| 37 | + |
| 38 | +This provides a representation of the Perl 6 [META |
| 39 | +files](http://design.perl6.org/S22.html#META6.json) specification - |
| 40 | +the META file data can be read, created , parsed and written in a manner |
| 41 | +that is conformant with the specification. |
| 42 | + |
| 43 | +Where they are known about it also makes allowance for "customary" |
| 44 | +usage in existing software (such as installers and so forth.) |
| 45 | + |
| 46 | +The intent of this is allow the generation and testing of META files for |
| 47 | +module authors, so it can provide meta-information whether the attributes |
| 48 | +are mandatory as per the spec and where known the places that "customary" |
| 49 | +attributes are used, |
| 50 | + |
| 51 | + |
| 52 | +## Installation |
| 53 | + |
| 54 | +Assuming you have a working perl6 installation you should be able to |
| 55 | +install this with *ufo* : |
| 56 | + |
| 57 | + ufo |
| 58 | + make test |
| 59 | + make install |
| 60 | + |
| 61 | +*ufo* can be installed with *panda* for rakudo: |
| 62 | + |
| 63 | + panda install ufo |
| 64 | + |
| 65 | +Or you can install directly with "panda": |
| 66 | + |
| 67 | + # From the source directory |
| 68 | + |
| 69 | + panda install . |
| 70 | + |
| 71 | + # Remote installation |
| 72 | + |
| 73 | + panda install META6 |
| 74 | + |
| 75 | +Other install mechanisms may be become available in the future. |
| 76 | + |
| 77 | +## Support |
| 78 | + |
| 79 | +This should be considered experimental software until such time that |
| 80 | +Perl 6 reaches an official release. However suggestions/patches are |
| 81 | +welcomed via github at |
| 82 | + |
| 83 | + https://github.com/jonathanstowe/META6 |
| 84 | + |
| 85 | +I'm particulary interested in knowing about "customary" (i.e. non-spec) |
| 86 | +fields that are being used in the wild and in what software so I can |
| 87 | +add them if necessary. |
| 88 | + |
| 89 | +## Licence |
| 90 | + |
| 91 | +Please see the LICENCE file in the distribution |
| 92 | + |
| 93 | +(C) Jonathan Stowe 2015 |
| 94 | + |
0 commit comments