#############################################################################
#
#    Project:  PyAALib-JyAALib Asynchronous Action Library Project
#              http://pyaalib.sourceforge.net/
#              http://jyaalib.sourceforge.net/
#
#
#    License:  PyAALib-JyAALib Asynchronous Action Library
#    Copyright (C) 2005, 2006, 2007, 2008, 2009  Romeu Andre' Pieritz (romeu.pieritz@gmail.com)
#
#
#    This program library is free software: you can redistribute it and/or modify
#    it under the terms of the GNU Lesser General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#
#    This program library 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 Lesser General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    and the GNU Lesser General Public License along with this program.  
#    If not, see <http://www.gnu.org/licenses/>.
#
#############################################################################
#
#       File: INSTALL.txt
#    Version: 20090428 - Candidate Release 7
#     Author: Romeu Andre' Pieritz (romeu.pieritz@gmail.com)
#
#############################################################################




================================================================================
The PyAALib Complete DISTRIBUTION TREE contains:


/documents
    ->The documentation files , html, pdf, tutorials and other files;
/modules
    ->The modules source code: Python and Java-Jython files;
    ->The complete PyAALib TestFramework with UnitTest, TestSuite, TestCase and TestControl files;
    ->The "bat" and "script" files to drive the tests on Linux, Windows and Mac;
    ->The basic documentation in html files;
    ->The ALAction framework - The "Atomic Thread" manager for parallel programming;
    ->The TagDebug engine;
    ->The Profiler engine;
    ->The Generic Dynamic Plug-in Factory framework;
    ->The DataBinding Classes for XSD and XML;
    ->The ALApplication Massively Parallel application code skeleton;
    ->The ManagerProcess architecture to manipulate external softwares 
      (talking directly with the OS task list to avoid Java and Python limitations);
/examples
    /hello-CmdFile
    /hello-ParallelCluster
    /hello-TagDebug
    /helloWorld
    /helloWorld-Jython
    /helloWorld-universalStandAlone
    -> Scripts to test the examples on Windows and linux
/libraries
    ->The Java-Jython-PyAALib "jar"  file to be used in a pure java configuration, it
      doesn't need pyhton or jython installed in the target system;
/tests
    /DataForTests
        -> It contains data for the TestFramework test the library components;
/AUTHORS.txt
/INSTALL.txt
/LICENSE.txt
/LICENSE-GPL-3.0.txt
/LICENSE-LGPL-3.0.txt
/RELEASE.txt
/VERSION.txt
    

================================================================================
SYSTEM REQUIREMENT:
for Python or Java/Jython: for all systems (MacOSX, Windows, Linux)
    ->Python 2.2 or last
    or
    ->Java Virtual Machine and Jython 2.2 or last


================================================================================
INSTALL: 
From the tar or zip file: for all systems (MacOSX, Windows, Linux)
    ->unzip or untar the distribution file.
    ->Set your PYTHONPATH(for Python) and classpath(for JAVA) to the "{pyaalib}/modules" folder

From the subversion server on Sourceforge - For all platforms:
Use anonymous login to download the day by day code
WARNING: maybe unstable or with new features

use the Subversion command:
svn co https://jyaalib.svn.sourceforge.net/svnroot/jyaalib jyaalib

more details in the subversion site: http://subversion.tigris.org 


================================================================================
To TEST:
    -> configure the files "test-*" on the "ROOT/modules" folder to use 
      your system libraries (Python and Java);
    -> execute *.sh" for MacOSX and Linux (change the permission for a shell script execution);
    -> execute *.bat" for Windows;
    -> to test the examples: configure the "*.bat" and *.sh" scripts in the examples folder



================================================================================
DOCUMENTATION:
    -> available on the "/documents" folder - index.html and HOWTO.pdf;
    -> available on the "/modules" folder - README.pdf;
    -> available on the web site http://jyaalib.sourceforge.net


Thank you for your interest. Enjoy it!
Romeu.