Wsmake
				 ======

The README describes Wsmake:
 * About
 * Documentation
 * Feedback
 * Licensing
 * Release Notes
 * Binary Availability
 * Build Requirements


				 About
				 =====

Wsmake is a website pre-processor. Although engineered with websites in
mind, it's capabilities allow it to be used for pre-processing any type
of site data that involves any of the following characteristics:

  * Common header and footer data
  * Deep nesting of file compilation
  * Dynamic generation of content that is usually static
    to the end user
  * Diverse scripting environments


			     Documentation
			     =============

The following are many places where documentation can be found:

  * In the `doc' directory of the source distribution.
  * In the `/usr/share/doc/wsmake' directory on Debian GNU/Linux.
  * At the website: http://www.wsmake.org/docs/


				Feedback
				========

Currently Wsmake is going through a rewrite which reimplements or
implements all of the above. You are encouraged to provide feedback:

  * Mailing Lists
    http://www.wsmake.org/mailman/listinfo/

  * Bug Reports
    bugs@wsmake.org

  * Contact Authors
    Michael L. Brownlow <mike@wsmake.org>


			       Licensing
			       =========

For licensing instructions, read the file `LICENSE' in the source
distribution.


			     Release Notes
			     =============

For release notes, read the file `NOTES' in the source distribution.


			  Binary Availability
			  ===================

Unless you intend to compile Wsmake yourself, you will need to download
a binary distribution. Binaries for a few popular systems are available
on the Wsmake website:

  http://www.wsmake.org/download/


			   Build Requirements
			   ==================

Wsmake should compile on POSIX systems without problems. If you do find
a problem it is probably because I do not have access to that particular
system. Regardless of why, you are encouraged to provide feedback so
that improvements can be made.

Some systems for which I test and build are:
  Debian GNU/Linux i386 (unstable)
  FreeBSD
  Cygwin (Windows 2000)

Some effort is in progress for non-POSIX systems, but it is currently
not a focus for Wsmake.

In addition to the system requirements, the following system programs
and libraries are needed:

 +------------+------------------+-----------+
 | Dependency | Test Environment | Necessity |
 +------------+------------------+-----------+
 | Lex        | flex             | required  |
 | Yacc       | bison            | required  |
 | BerkeleyDB | libdb v3         | optional  |
 |       . - = Under Construction = - .      |
 +-------------------------------+-----------+

Pre-bootstrap requirements are the autotools (latest versions always):
  m4       - http://www.gnu.org/software/m4/m4.html
  automake - http://www.gnu.org/software/automake/automake.html
  autoconf - http://www.gnu.org/software/autoconf/autoconf.html
  libtool  - http://www.gnu.org/software/libtool/libtool.html

Instructions for compiling and installing wsmake:
  $ ./bootstrap       (only needed if checked out of CVS)
  $ ./configure
  $ make
  $ make install

By default, the above will install the wsmake binary at:
  /usr/local/bin/wsmake
And the documentation at:
  /usr/local/share/doc/wsmake

Using the `--prefix' option to configure will allow a different
installation location. E.g.:

  $ ./configure --prefix=/home/myhomedir

When installing with the prefix `/home/myhomedir' the Wsmake binary will
be at:
  /home/myhomedir/bin/wsmake
And the documentation will be at:
  /home/myhomedir/share/doc/wsmake

To see other options for compilation, run:
  $ ./configure --help

-----------------------------------------------------------------------------
Website       : http://www.wsmake.org/
Mailing Lists : http://www.wsmake.org/mailman/listinfo/
Author        : Michael L. Brownlow