[pmwiki-users] Root README.txt With a docs/ Directory
H. Fox
haganfox at users.sourceforge.net
Thu Dec 29 18:38:35 CST 2005
[So as not to sound snarky on the list, I'm sending this separately.]
On 12/29/05, Patrick R. Michaud <pmichaud at pobox.com> wrote:
> I'm not sure that these 2 (3 if we create an INSTALL.txt) files
> deserve their own directory. Perhaps there are a number of other
> things that will go in the docs/ directory, but following
> PmWikiPhilosophy #3, until we do have them I think it's better
> to stick with what we have now.
Fair enough, though that defines an informative README.txt file and a
non-servable location for documentation as a "gratuitous feature".
For existing users, that may be so.
For brand new PmWiki 2.1 users, it's (IMHO, of course) a huge
improvement to have a thoughtful README.txt (and probably INSTALL.txt)
file. One of the things that I find really annoying about *most* GPL
software is that authors seldom answer all of
What does this program do?
What are all these files / directories?
How do I get started?
in an easy-to-find README.txt file. Programs that do so really stand
out in my mind.
Hagan
More information about the pmwiki-users
mailing list