Skip to content

Commit c154746

Browse files
committed
Somewhat describe the resources thing in modules doc
1 parent 0816047 commit c154746

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/Language/modules.pod

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,8 @@ To share your module, do the following:
327327
`-- Gargravarr.pm
328328
=end item
329329
330+
=item If you have any additional files (such as templates or a dynamic library ) that you wish to have installed so you can access them at runtime they should be placed in a C<resources> sub-directory of your project.
331+
330332
=item The C<README.md> file is a L<markdown-formatted|https://help.github.com/articles/markdown-basics/> text file, which
331333
will later be automatically rendered as HTML by GitHub.
332334
@@ -370,6 +372,7 @@ To share your module, do the following:
370372
"Vortex::TotalPerspective" : "lib/Vortex/TotalPerspective.pm"
371373
},
372374
"depends" : [ ],
375+
"resources" : [ ],
373376
"source-url" : "git://github.com/R<you>/Vortex-TotalPerspective.git"
374377
}
375378
@@ -383,6 +386,12 @@ To share your module, do the following:
383386
your distribution and set C<perl> version to the minimum perl version
384387
your module works with
385388
389+
The C<resources> section is optional, but, if present, should contain a
390+
list of the files in your C<resources> directory that you wish to be
391+
installed, these will be installed with hashed names alongside your
392+
library files and their installed location can be determined through the
393+
C<%?RESOURCES> Hash indexed on the name provided.
394+
386395
=end item
387396
388397
=item Put your project under git version control if you haven't done so

0 commit comments

Comments
 (0)