-----------------------------------------------------------
Note: Plex86 documentation uses the GNU Free Documentation License.
Read the file COPYING, for the terms of this license.
-----------------------------------------------------------

This is the documenation tree for plex86.  There is a directory
for each type of input format that documentation may be written
in.  Preferably, all new docs should be written in XML/DocBook.

=================================
Using pre-formatted documentation
=================================

  If you don't want to generate output files (html/PostScript/etc)
  from these docs, you can use ones which were formatted for you.
  The (fairly) latest ones are available in ftp://plex86.org/docs/.
  Untar'ing the files from this directory is equivalent to make'ing
  them.

    user-> cd plex86/docs/     # Cd to this directory
    user-> tar xvfz /tmp/docs-YYYY_MMDD_HHMM.tar.gz


===========================================
Formatting the docs using DocBook/XML tools
===========================================

  Use this option if you want to format the docs yourself, and
  you have DocBook/XML tools installed on your system.  (Read
  'xml/README' for more info)  This is useful if you want to help
  edit/create documentation or want the latest docs.

    user-> make html       # If you want HTML
    user-> make ps         # If you want PostScript

======================
The directory hiearchy
======================

All formatted text will go in a subdirectory of output/, depending
on the format type.  There is one subdir for each type:

  output/ps/
  output/html/
  output/...

As there are 2 distinct DocBooks - one is the "Plex86 Users Guide"
and one is the "Plex86 Internals Guide" - there may be 2 subdirs
or files in each of the above directories.

The Makefile in this directory, commands each of the Makefiles
in input format subdirectories to generate a particular type
of output format, for example html or ps, which is put in the output/*
directory.

The entire output/ directory is generated dynamically and is
recursively erased upon 'make clean', so we don't accumulate extraneous
files.

-Kevin
