
                          JyConsole 
             Advanced Java based Jython graphic console
                 (c) Artenum, Paris, France, 2005
                 http://www.artenum.com/jyconsole
                 
                    Version 1.3 (July 2006)

Authors: 
    - Sebastien Jourdain (Artenum), contact: sebastien.Jourdain@artenum.com
    - Artenum SARL, Paris, France. 

1) Introduction / Purpose

   JyConsole is an advanced Java console for Jython, able to manipulate
   Python and Java objects.

   JyConsole is fully written in Java and based on the Jython library and
   modules. It answers to several requirements of modern consoles, such as
   command history, completion, easy script loading and basic GUI preference
   management.

   More especially, JyConsole provides an advanced object oriented completion
   on Java and Python objects. JyConsole allows the direct manipulation of any
   objects used in the python and class paths, independently of their initial
   language (Java/Python).
 
   JyConsole can be extended as any application, but its first goal is to
   offer a simple and powerful Java/Python console fully portable. JyConsole
   can be directly used as standalone application or as a embedded
   graphical component into a Java or Jython application.

2) Build

   To build JyConsole to your computer you will have to download the 
   thirdpart libraries and update a configuration file where you will have 
   to specify the path of those library.

   See the "THIRDPART.txt" for more details. (Could be in the provided thirdpart 
   directory)

   The configuration file to update is "config.properties" that you must 
   create from the "config.sample" file which is the base of the properties
   needed for the compilation and the packaging process.

   Then use ANT in order to generate the engine components.

   => Ant task available:
       - clean   : remove all builded documents. (class, jar, javadoc)
       - jar     : generate the jar file for the JyConsole
                   library and place it in the binary-package directory
       - javadoc : generate the javadoc of the source code and place in 
                   the Doc/API directory
       - exec    : generate the script for the code execution and place 
                   them in the binary-package directory
       - make    : execute jar and exec and remove the build directory

3) Contact

    E-mail: jourdain@artenum.com

    Mail: Artenum SARL
          101-103, Bd Mac Donald
          75019 PARIS, FRANCE

    Phone: +33(0)1 44 89 45 15
    Fax:   +33(0)1 44 89 45 17



