Read Me

********************************************************************************

                                 MJConsole
                                 
                Copyright (C) 2006, Adolfo Riera Alvarez

********************************************************************************

   Index:

1.- Release info
2.- License
3.- Description
4.- Requeriments
5.- Installation
6.- Documentation
7.- Disclaimer
8.- Contact 


--------------------------------------------------------------------------------


1.- Release info

    MJConsole v0.1


2.- License
    
    MJConsole is distributed under the terms of the GNU GENERAL PUBLIC LICENSE 
    version 2. A copy of this license is distributed with the application.


3.- Description

    The objective of this project is to develop a programing tool that minimize
    the time and effort spent by a developer building a text user interface.

    This tool will be composed by two elements:

    * A "command empty" text console. A text console that could parse 
      information from command line, and call the right action with the given 
      parameters; but it doesn't define which actions are available.
    * An API that could be used to build the actions that the console must allow
      to perform.


4.- Requirements

    The MJconsole needs a Java 2 Runtime Environment (J2RE) installed to run.
    

5.- Installation

    Do one of the following:
    
    * Copy the dist/mjconsole_[version].jar into a directory that is included in
        your CLASSPATH environment variable.
    * Copy the dist/mjconsole_[version].jar whereever you want and include it's
      full path into the CLASSPATH variable.
    * Copy the dist/mjconsole_[version].jar whereever you want and invoque the 
      MJConsole include the file's full path in the -cp option:
    
    java -cp path/mjconsole_[version].jar net.sourceforge.mjconsole.MJConsole


6.- Documentation

    You can find the MJConsole usage and design documentation under the doc/ 
    directory.
    

7.- Disclaimer

    Foobar 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.
    
    
8.- Contact info

    Adolfo Riera Alvarez
    adolfo.riera@gmail.com
    c\Canido 197, Vigo, C.P.36390 Spain