The Secret of NIM Files

#########################################################################
##                                                                     ##
##                         The Secret of NIM                           ##
##                  An easy way to remerber NIM logic                  ##
##                                                                     ##
#########################################################################
Version 1.1.9beta du 16/04/2014
by Arnaud DOCHAIN arnaud.dochain(at)gmail.com
Website : http://sourceforge.net/projects/cablage2000/

-------------------------------------------------------------------------
---                           Description                             ---
-------------------------------------------------------------------------
The Secret of NIM is a software writen in PHP/MySQL and JavaScript.
It shows a graphical representation of a logic scheme
with wires connecting logic modules which have specific parameters.
This software has been developped for NIM/TTL logic,
thus his simplicity allows also the representation of other
logic systems, numeric systems or analogic systems i.e. the pedal
board of an electric guitar.

The Secret of NIM is divided in two parts. The first one is the main part
of the software. It edit different project, connect modules with wires
and edit the parameters of those modules. The other part of the
sofware is an utility. It edits the modules which will be used for
the projects or create them if they aren't in the database yet.

The Secret of NIM is a all-in-one software, easy to use and very
helpful for saving the wiring of an experiment. But it can't do the
logic itseft, it allows only a visualisation of the logic.

-------------------------------------------------------------------------
---                        System Requirement                         ---
-------------------------------------------------------------------------
1. Server side  : - Apache 2.2 (2.2.22 used)
                  - PHP 5.3    (5.3.10 used)
                  - MySQL 5.5  (5.5.34 used)
2. Client side  : -  Firefox 26
                  or Google Chrome 31
                  or Internet Explorer 10
Other browser may work but hasn't been tested yet.

-------------------------------------------------------------------------
---                           Instalation                             ---
-------------------------------------------------------------------------
1. Unzip the folder and paste it on the server.
2. Make sure that folders and file can be created/edited and deleted
   by PHP (chmod 0777).
3. Open a web browser and load the page "./index.php"
   or "install/index.php".
4. Enter the following MySQL informations :
   - Host name     : the adress of the MySQL server (usualy "localhost",
                     but it may vary).
   - Username      : the username used to connect to MySQL
   - Password      : the passowrd...
   - Database name : The name of the database where the Secret of NIM
                     will be stored.
   - Table Prefix  : a prefix added to the name of your tables in the
                     database. Be sure that it's not used by another
                     program.
   If you are on an external web hosting service, they might have
   given to you the Hostname-Username-Password-Database name.
5. Click on "Initialize database"
6. The Secret of NIM is now ready to use. If not, there might be
   a problem with the operation 2 or 4.

-------------------------------------------------------------------------
---                        Functionnalities                           ---
-------------------------------------------------------------------------
1. Projects :
   + Add project
   + Delete project
   + Edit project
     + (name/description)
     + Rack
       + Add
       + Move
       + Resize
       + Delete
     + Module
       + Add
       + Move
       + Delete
     + Parameters
       + Edit values and unit
     + Wires
       + Add
       + Move
       + Edit length
       + Delete
   + Save project on the disc (.zip file)
   + Load project from the disc (.zip file)
   + Projects repair (if a bad manipulation has been done)

2. Modules :   
   + Add module
   + Delete module
   + Edit module
     + Informations
       + Description
       + Name
       + Associated image
     + Plugs
       + Add
       + Edit
         + Name
         + Position
         + Input or Output
       + Delete
     + Parameters
       + Add
       + Edit
         + Name
         + Position
       + Delete
   + Import module
   + Export module
   + Repair modules (clean database)
 
3. Advanced functionnalities
 + Optimize database (reduce the index values)
 + Reset database (Delet all projects and modules)

-------------------------------------------------------------------------
---                       Thanks for reading !                        ---
-------------------------------------------------------------------------