Skip to content

Commit b187705

Browse files
committed
Improving the description of META6.json
For the time being, no new section. If you think it's absolutely necessary, reopen the issue. Closes #551
1 parent 27f3a15 commit b187705

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

doc/Language/modules.pod6

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -537,6 +537,7 @@ lib
537537
{
538538
"perl" : "6.c",
539539
"name" : "Vortex::TotalPerspective",
540+
"auth" : "github:SomeAuthor",
540541
"api" : "1",
541542
"version" : "0.0.1",
542543
"description" : "Wonderful simulation to get some perspective.",
@@ -546,7 +547,12 @@ lib
546547
"Vortex::TotalPerspective" : "lib/Vortex/TotalPerspective.pm6"
547548
},
548549
"depends" : [ ],
550+
"build-depends" : [ ],
551+
"test-depends" : [ ],
549552
"resources" : [ ],
553+
"tags": [
554+
"Vortex", "Total", "Perspective"
555+
]
550556
"source-url" : "git://github.com/R<you>/Vortex-TotalPerspective.git"
551557
}
552558
=end code
@@ -557,6 +563,8 @@ lib
557563
details). If the version number doesn't matter to you or your users
558564
right now, you can just put in an asterisk (*) for the version.
559565
566+
The C<auth> section identifies the author in GitHub or other repository hosting site, such as Bitbucket.
567+
560568
The C<authors> section includes a list of all the module authors. In
561569
the case there is only one author, a single element list must be
562570
supplied.
@@ -582,7 +590,9 @@ lib
582590
list of the files in your C<resources> directory that you wish to be
583591
installed, these will be installed with hashed names alongside your
584592
library files and their installed location can be determined through the
585-
C<%?RESOURCES> Hash indexed on the name provided.
593+
C<%?RESOURCES> Hash indexed on the name provided. C<tags> is also optional, but is used to describe the module in the Perl6 ecosystem.
594+
595+
C<depends>, C<build-depends> and C<test-depends> include different modules that are used in those phases of the of installation. The last two are optional, but convenient.
586596
587597
The L<Test::META module | https://github.com/jonathanstowe/Test-META/>
588598
can help you check the correctness of the META6.json file.

0 commit comments

Comments
 (0)