-----BEGIN PGP SIGNED MESSAGE----- Moin,
On Monday 13 October 2003 11:57, Michael G Schwern wrote: > On Mon, Oct 13, 2003 at 10:28:29AM +0200, Thomas Klausner wrote: > > * contains files: > > * Makefile.PL or Build.PL or configure > > configure? > > > * README > > Personally, I find READMEs useless duplication. Even more so now that > search.cpan.org works so well. You have never maintained a big project, were the *brief* introduction in README is 8 pages, accompanied by an INSTALL file with another 15, not to speak of the $three-digit-figure pages of userland documenatation :) In that case a README is a lifesaver, because it is, if ever, the only thing someone reads :) (That was a joke about you personally. :-) I find that a short intro in the README (if it isn't immidiately replicated in the .pod, where it does _not_ belong if there are more than on .pm files) is very usefull. Unfortunately, not every project has a README, or a useless one (like just a boilerplate or something like this). The README should explain the goals and target of the package, contact points etc etc.. I agree that merely having one doesn't say much, but if it is lacking, that certainly shows the authors attitude... > > * t/* or test.pl > > test.pl is not a good thing. It doesn't get parsed by "make test". It > just runs and spits the output to the screen. If a test fails, "make test" > will still succeed. Still, its better than nothing at all. If there are t/* _and_ test.pl this probably should be marked as "bad". test.pl is usually old cruft still lingering around :) > > * one *.pm in top-level OR lib/ > Or Module/*.pm. Seems a little dubious anyway, there are POD-only modules. And what about doc/Somedoc.pod files? Just my 0.02Eurocent, Tels - -- Signed on Mon Oct 13 18:51:43 2003 with key 0x93B84C15. Visit my photo gallery at http://bloodgate.com/photos/ PGP key on http://bloodgate.com/tels.asc or per email. "Now, admittedly, it's critical software. This is the 'let's go kill people' software." -- Mark A. Welsh III -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.2-rc1-SuSE (GNU/Linux) Comment: When cryptography is outlawed, bayl bhgynjf jvyy unir cevinpl. iQEVAwUBP4rYKHcLPEOTuEwVAQG6mwf+Ke2wRst2S3FEUtb+x0SgTsbNtuJGc3e8 71nycuArl2eXhRYyyk7yZm73AxPWdE6cyOcSg94Y0MtD2t58OMDiRUksomLRtMBC TD441s1Wmx3HrxYqTGLHLeuDmJjVbsCnFJkr8Vfc/cPbp0u+yDFo5ZtaF1QhIWXQ djAMTWLjgaYk9OfxswiTj1YohQIGzzqTaHlQalvU4GyHYz0enAT71YGyHF/ZEYz6 d5BsvdMFLIobx/zvyWYKMkdd5hv45oL621L2S+I0tKevZzbWe9MNmGB1MvWFb7hy WlH/7wVT7qq3QHlo4O8fzoVMU1zFfGBoff7uLeL8rh7vEPuLs3L2ow== =uqva -----END PGP SIGNATURE-----
