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

H. Fox haganfox at users.sourceforge.net
Thu Dec 29 22:51:11 CST 2005


On 12/29/05, DaveG <pmwiki at solidgone.com> wrote:
> > The idea is to keep it simple for first-time installers.  Less is more.
> I'll weigh in as a relative newcommer. It is *very* helpful to have a
> basic install.txt file -- even now after a few upgrades I have to do a
> quick think before I move forward. Upgrading/installing is a simple
> process, so keep the install.txt simple as well.

A docs/UPGRADE.txt document could be file *very* handy to have around,
if only to remind someone of the command syntax necessary to copy the
files (cp -a ...).

> > I think it's helpful to have self-contained instructions, even if
> > they're only minimal.
> I agree. A link for further reference may not hurt, but that tends to
> prompt the reader to thinking there's more info they are missing out on :)

Heh.  Curious types will appreciate having that option.  For others,
the further-reference link might only be used if the minimal
instructions somehow fall short.

> Farms install's I'd either put in a separate TXT or provide a link to
> the info on-line.

Maybe a WikiFarm-Install.txt file (with a better name) would be good
idea.  I haven't jumped into PmWiki farming yet.  I tend to be a
WikiHunterGatherer myself.  :-)

Hagan




More information about the pmwiki-users mailing list