Essence Engine - PHP Website Management Software
================================================

Copyright (C) 2004-2005 Brandon Amedee <exonyte at exonytesrealm dot com>
Contributions by Keith Gable <ziggy at ignition-project dot 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.
	
In addition to being restricted by the GNU General Public License, Essence
Engine may not be sold, rented, sublicensed, or leased; you are not
permitted to generate revenue with the Essence Engine source code. You may,
however, use Essence Engine to run a website that generates revenue via
other means.	

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.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

$Id$


HOW TO INSTALL ESSENCE ENGINE
=============================
(WARNING: CRUMMY ASCII ART AHEAD!)

Essence Engine is currently very early in development. So, with that in
mind, please understand that it is not for the faint at heart. It
requires more experience than is normally needed for another system,
such as PostNuke or PHP-Nuke.

Please do not ask us for help if you run into trouble. In the future,
there'll be a setup script that will make it easy. Until then, well,
you can just wait :).

Here's what you do:

1) Run all of the SQL queries in db_structures.sql. This can be done
   inside phpMyAdmin (SQL tab of a database), using phpMyAdmin's
   SQL import function. This also can be done on the command line,
   using a command similar to this (please note: $ is the prompt):

   $ mysql -p -u username -D database < db_structures.sql

2) Next, edit initial_user.sql in Notepad, Gedit, or equavilent. You
   should really only care about changing the username, since the rest
   can be changed from within Essence Engine itself. If "admin" is a
   suitable username, feel free to leave this file alone. Otherwise,
   you'll need to change "admin" to whatever username you want.
      _ 
     / \      ** WARNING! ** ALL USERNAMES MUST BE LOWERCASE!
    / ! \     FAILURE TO UNDERSTAND THIS WILL PROBABLY BREAK THINGS
   /_____\    AND BREAKING THINGS IS NOT GOOD!

   Seriously! If you need to change the case, you may do so from within
   Essence Engine!

3) Import the SQL query in initial_user.sql, just like you did in #1.

4) Edit websitesettings.editme.php, changing all of the data to match
   your configuration. Then, rename it to websitesettings.php.

5) Visit your site and hope it works. If it does, congratulations! If
   it doesn't, well, sorry! These instructions work perfectly fine for
   us, so make sure you're following them to the tee. :)


WHAT CAN I DO TO HELP?
======================

We keep a bug tracker on <http://bugs.ignition-project.com/>. Find some
bugs and report them under the Essence Engine product (but, of course,
please look for duplicates first).

If you know PHP, check todo.txt. It's an output of a grepping (actually,
it's the output of todo.sh). It shows all of the occurances of "TODO"
in all of our files. See if you can finish them. Look for a bug on
Bugzilla (above) about each todo item. If one does not exist, please create
one for us.

Thanks for helping!


I WANT TO USE THIS ON MY SITE
=============================

Go ahead. Consider it fluid software, however. Update the sourcecode
regularly so bugs and security holes get fixed. If you changed something
that conflicts, you'll need to move that file away and do some clever
fixing. It's development software; deal with it.


GENERAL REMARKS
===============

Please, for the love of everything holy, read the license. It is NOT a
GPL license. It's the GPL with a restriction. All modifications are
placed under the restricted GPL license, and not the GPL. If you wish to
sell stuff using Essence Engine, feel free. But Essence Engine itself
must always remain free. You cannot charge for it. If you include it
on a CD that costs money to get (or, on some FTP site that requires
money to access), you will need to contact the developers (look on
the header of every file).