Ensure dist contains a README.md file
Documentation is important, especially to people looking for a particular module or trying to use it correctly. As such, I think it's not a bad idea to enforce a README.md
to exist. I'm going for Markdown as the format, because this is supported on modules.perl6.org.
If a README.md
or README
(without extension) exists, don't do anything. When neither of these files exists, try the following steps:
- Check for a
README.pod6
, if it exists, convert this toREADME.md
. - Extract the Pod from the
pm6
file with the same name as the actual module name, i.e.: Pod fromlib/Foo/Bar.pm6
will be used for moduleFoo::Bar
. - Convert the Pod file with the same name as the actual module name, i.e.:
lib/Foo/Bar.pod6
will be converted toREADME.md
for moduleFoo::Bar
.
For all these tries it is of course required that the source file exists. The README.md
should also be removed again after the distribution creation process, as to not leave redundant files in the developer's environment.
It might be interesting to add a project-wide configuration file to App::Assixt
in which one can define a .pm6
or .pod6
file, from which the README.md
can be generated.