search

Perl5-Alien / Alien-Base

Base classes for Alien:: modules (deprecated, see Alien-Build)
Other
35 stars 19 forks source link

[PRC] Reorganize navigation of documentation #187

Closed JJ closed 7 years ago

JJ commented 7 years ago

Also adds cpanfile for easier local installation. I have navigated the documentation, noticed a possibly unneeded file (see #186 ) and reorganized pointers, as well as fixed a typo in this possibly unnecessary file. I can go ahead and try and test-drive the documentation as pointed out in #185 . I do use external dependencies for some of my modules. I will create a separate PR.

plicease commented 7 years ago

Merged, except for the cpanfile. For now I don't want to maintain the prereqs in two files, but we may add a cpanfile later.

jberger commented 7 years ago

I'm a big fan of cpanfile, but I agree with @plicease, we shouldn't have two copies of the prereqs to manage. A great part of cpanfile is that it makes for literate (in this case declarative) programming. But allowing for skew by only using it as documentation would be more of a detriment than a benefit.

JJ commented 7 years ago

Maybe, as an alternative, move it to another directory? Thanks anyway for accepting the PR :-)