Read Me

-------------------
Yawic version 0.2
-------------------

Okay, we are not really original :). Yawic stands for “yet another web
interface class”. It’s a php class for quickly creating webbased database
interfaces.

There are many classes and frameworks around on the web which give you this
functionality, but we have specific wishes on how it should work.

What does it do ?
* Gives you easy web access read/write/list/add/delete to data 
  in your mysql based database.
* Automatic page generation based on database metadata. 
* Desktop-like interface (using ajax).
* Easy customization via a configuration file (for now a limited number of 
  options)

The latest version and more information (including a complete feature list) 
can be found on http://yawic.org

----------
DISCLAIMER
----------

This is a pre-alpha version that will probably contain lots of bugs, 
so use it at your own risk.

-------
License
-------

Copyright (c) 2007 Gert-Jan de Jonge & Petra de Jonge.
Yawic is released under the LGPL, see LICENSE.txt

------------
Requirements
------------

* web server
* php5		(http://php.net)
* mysql5	(http://mysql.com)	
* xajax 0.5 	is included in the package, if you got yawic from the 
                sourceforge subversion repository, you should download and 
                unpack xajax as a subdirectory of yawic

------------
Installation
------------

* Make sure the web server / php5 / mysql5 is working.
* Download and unpack yawic in a directory accessible by the webserver.
* Check demo.php for an example of how to use the yawic class.
* config/<database name>.yawic is used as configuration file, 
  see test/extra_data.yawic for a list of all options

-------------------
Setting up the demo
-------------------

* To create the database yawic_demo, import the dumpfile yawic_demo.sql in
  mysql.
* Setup a user to have at least select/insert/update/delete rights 
* In demo.php, set the parameters of call to new yawic(...) to the correct 
  username and password (and possibly server).
  


--------
Security
--------
To make sure database names and passwords cannot be retreived, the config
directory is secured by a .htaccess file. Make sure your webserver supports
this.