[pmwiki-users] Re: Root README.txt With a docs/ Directory

H. Fox haganfox at users.sourceforge.net
Fri Dec 30 15:59:26 CST 2005


On 12/30/05, Patrick R. Michaud <pmichaud at pobox.com> wrote:
> On Fri, Dec 30, 2005 at 12:25:08PM -0500, Waylan Limberg wrote:
> > That wasn't clear to me at first. I was working on a unconnected
> > machine, and after spending a few weeks going back and forth between
> > two machines checking the docs at pmwiki.org and making adjustments, I
> > finally realized everything was right there. Pointing that out in a
> > README file would have clued me in much quicker, as that would have
> > been the first thing I looked at after unpacking the download.
>
> After thinking about this a little bit more, I'm actually a little
> surprised.
> [...]
> So, what exactly does the README.txt file need to say about
> the local availability of the documentation, and where does
> it need to be said?

Not much, if anything.  Less is more in the README.txt file.  How about

   Documentation is included in wiki pages that are installed along
   with the software, and also on line at http://pmwiki.org/

That should be in docs/INSTALL.txt, really.

Hagan




More information about the pmwiki-users mailing list