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

[H. Fox]

On 12/28/05, H. Fox <haganfox at gmail.com> wrote:
>
> I'm not a fan of adding another directory unless it makes things
> clearer, especially for someone installing PmWiki for the first time.
> I think adding a docs/ directory would accomplish just that.
>

OK, I've put some more thought into this.  The following addresses the
questions someone may have after unpacking a PmWiki distribution
archive.

* In the root, place a README.txt that reads something like

    This is the README.txt file for PmWiki, a wiki-based system for
    collaborative creation and maintenance of websites.  PmWiki is
    distributed with the following directories:

      docs/           Documentation and sample configuration files
      local/          Local configuration scripts
      cookbook/       Recipes (add-ons) obtained from the Cookbook
      pub/            Publicly accessible files
      pub/css/          CSS stylesheet files
      pub/skins/        Layout templates (skins)
      scripts/        Some scripts that are part of PmWiki
      wikilib.d/      Some default wiki pages

    For installation advice, see  docs/INSTALL.txt or visit
    http://www.pmwiki.org/wiki/PmWiki/Installation

    PmWiki is Copyright 2001-2005 Patrick R. Michaud
    pmichaud at pobox.com
    http://www.pmichaud.com/

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    The GNU General Public License is distributed with this program
    (see docs/COPYING.txt) and it is also available online at
    http://www.fsf.org/licensing/licenses/gpl.txt

* The docs/ directory would have files like

    docs/
      .htaccess
      COPYING.txt
      INSTALL.txt
      cms-config.php
      sample-config.php
      secure-config.php
      [...]

* The next few releases (right up until the last 2.1 beta) would have
something like the following in the root's sample-config.php file.

    <?php
    #
    # This file has been moved.  See docs/sample-config.php
    #

Hagan