+ restructured test cases
[qpalma.git] / README
diff --git a/README b/README
index 20cbdbd..121c233 100644 (file)
--- a/README
+++ b/README
@@ -1,34 +1,59 @@
-Installation instructions for QPalma Version 1.0.
+Installation instructions for QPalma Version 0.9
   
 The package requires version 2.5 or newer of Python, and is built from 
 source, so the header files and libraries for Python must be installed, 
 as well as the core binaries.
 
 
-Instructions
-------------
+Installation Instructions
+-------------------------
 
-Type
+You need the following packages
 
-   python setup.py build
+- SWIG  ( >=1.3.31 )
+- numpy ( >=1.0.4 )
+
+- Pythongrid
+- Genefinding
+
+You can obtain SWIG from http://www.swig.org and numpy from http://numpy.scipy.org/
+or ask your sysadmin to install the packages.
+
+Pythongrid and Genefinding are two utility packages from our lab. These can be obtained via:
+   
+   http://www.fml.tuebingen.mpg.de/raetsch/projects/qpalma
 
-to build the necessary C++ extension modules and copy the QPalma python code.
+Once you have the above packages installed you can start installing QPalma.
 
+Assuming you downloaded QPalma-0.9.tar.gz type:
+
+   tar -xzvf QPalma-0.9.tar.gz
+
+   cd QPalma-0.9
+
+   python setup.py build
 
+to build the necessary C++ extension modules and the python code.
 
 
+Setting environment variables
+-----------------------------
 
+You will need the following variables set:
 
+- SGE_ROOT should point to 
+- 
 
 
-Troubleshooting
----------------
+Further information
+-------------------
 
+   More extensive documentation can be found under the doc/ directory of the
+   QPalma distribution.
 
 
-HELP!
------
 
-If however everything failes contact:
+Contact
+-------
 
-fabio@tuebingen.mpg.de
+   qpalma@tuebingen.mpg.de