Read Me

===================
 NEURAL MESH
 Development Guide
===================

-------
TO DO:
-------

- Easier installation (Jud Stephenson)
- implement Hans' binary pattern gen.

-------
FIXED:
-------

- don't display own user in the users to delete list FFS (cth_goldenhawk, modified by louisstow to filter at DB layer)
- If gzcompress function does not exist, do not try compress (cth_goldenhawk)
- Reword supervised vs unsupervised. Make it 'offline' vs 'online'. (louisstow 17/03/2010)
- Implement bipolar (louisstow 17/03/2010)
- Add a network, change to "Hidden" not "Neurons" (louisstow 17/03/2010)
- Better proxy logic. One for each table. --(louisstow)
- Input method should be ranges and not explicitly 0,1. Find new way other than str_split(). explode on | (louisstow 22/03/2010)
- History exhausts memory, add a limit of 100 or so (louisstow 22/02/2010)
- Use PDO (louisstow 22/03/2010)
- Make it usable for other Databases (postGres) (louisstow 22/03/2010)
- Fix user management module (louisstow 22/02/2010)
- Implement Hans G. Doller's bar graph. now needs to range from -1 to 1 not 0 to 1. (louisstow 22/03/2010)

---------------
TO DEVELOPERS:
---------------

All developers will have their own branch which can be found under branches/[username]-[version number]/

ie. branches/louisstow-1.6.0/

DO NOT MODIFY TRUNK. At the end of development for the current version, all branches will be merged into the master (trunk) and released. After release, all user branches will be reset with the latest version number and code base. The latest version will also be tagged for reference.

ie. branches/louisstow-1.7.0/

Version numbers can be collaboratively decided based on the level of change (first number major change, second number medium change, last number small change).

A changelog will be kept logging the change, the date, the name of the developer and an optional URL (for contacting purposes). These changes will be grouped by the version number.

The to-do list above is known problems or features to be added. You may reserve an item by placing your username beside it in brackets.

--------------------
NAMING CONVENTIONS:
--------------------

Function Names: camelCase
Local Variables: lowercase
Class Variables: lowercase_with_underscore
Constants: UPPERCASE_WITH_UNDERSCORE
Class Names: lowercase
Comments:

/**
 * Javadoc. Include what and why of function
 * @param $var Description of var
 * @return What the function returns
 * @author Only in class definition
 */