Overview

FILES IN THIS DIRECTORY
=======================

environmentVars.sh
    A file containg the environment variables needed to run the server.

www/
    The main django project, which holds the settings for the server, and
    scripts to run the server.

pinyin/
    The main django app, which contains the database model and any code that
    interacts with the database. Most of the interesting stuff is in here.

tools/
    Used to be where we put our scripts. Now these scripts should go into the
    pinyin/ directory instead. This is where the main python support libraries
    are kept.

dict/
    Additional python support modules for dealing with dictionaries and nice
    interfaces to static data files, for example a pinyin conversion table.


HOW TO INSTALL THE SERVER
=========================

Firstly, there are some prerequisites which must be installed:
1. Python (>=2.4, usually intalled already)
2. Django 0.95 or later (http://www.djangoproject.com), with the patch in
   the patches/ directory installed. You install it by running
       patch -p0 < path/to/file.patch
   from within the django source directory. The patch ensures that the database
   connection occurs in unicode.
3. MySQL, MySQL-python
4. Boost-python

After this, you can start the server by running:
    source environmentVars.sh
    python www/manage.py syncdb		# needed the first time only
    python www/manage.py runserver

Then you can inspect the database by pointing your browser to:
    http://localhost:8000/admin