Changeset 2514 for trunk/README

Timestamp:

05/14/12 15:03:22 (13 years ago)

Author:

Malte Marquarding

Message:

Updated INSTALL and renamed to README

File:

• trunk/README (moved) (moved from trunk/INSTALL ) (2 diffs)

trunk/README

@@ -5 +5 @@
 * rpfits >= 2.19
 * cfitso >= 2
-* python >= 2.4
-* boost >= 1.37
-* casacore >= 1.0
+* python >= 2.5
+* boost >= 1.40
+* casacore >= 1.5
+* wcslib >= 4.13
 
 Installation
 ============
 
-scons has several targets. It is recommended to execute them sequentially.
-The normal install procedure is as follows
-.. code::
+ASAP is based on c++ and python. It uses python's standard packaging tool
+to build and install::
 
-   scons
-   scons makedist=1
-   cd asap-4.1.0
    python setup.py install
-   asap # exit with <Ctrl-D>
+
+If the dependencies are in custom locations there are two ways to build
+ASAP:
+
+ * edit the file 'setup.cfg' then run 'python setup.py install'
+ * give command-line parameters; run 'python setup.py build_ext' with the
+   options and then 'python setup.py install' 
+   (see python setup.py build_ext --help for the available options)
+
+Note: The installation must be done as 'root' or using 'sudo'
 
 Obtaining the data directory
 ============================
 
+ASAP needs some meta-data which updates periodically.
 The data repository can be obtained separately after installing ASAP.
-Before you run asap for the first time simply run::
+Run as root (sudo)::
 
     asap_update_data
@@ -35 +42 @@
 ==============================
 
-after building using 'scons', you can create a compressed tarball of the binaries. This is done via the target 'makedist='. The argument should be an obvious identifier for the system you want to support, e.g. 'sarge' or 'fc5-x86_64'::
+You can make a binary distribution for you platform by running::
 
     python setup.py bdist_egg
 
-This will create an archive in the subdirectory 'dist' named 'asap-X.Y.Z-py2.Negg', where X,Y,Z are the version numbers e.g 4.1.0.
+This will create an 'egg' archive in the subdirectory 'dist'.
+Send this to asap@atnf.csiro.au so other people can share it.
+