[h5py] 05/455: README update: install

[Ghislain Vaillant]

This is an automated email from the git hooks/post-receive script.

ghisvail-guest pushed a commit to annotated tag 1.3.0
in repository h5py.

commit ed63c7e6b1918dfe85548a1f4d46247939851aab
Author: andrewcollette <andrew.collette at gmail.com>
Date:   Mon May 5 23:07:23 2008 +0000

    README update: install
---
 MANIFEST.in |  1 +
 README.txt  | 55 +++++++++++++++++++++++++++++++++++++++++--------------
 setup.py    |  5 +++--
 3 files changed, 45 insertions(+), 16 deletions(-)

diff --git a/MANIFEST.in b/MANIFEST.in
index daea32d..e2c2257 100755
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,6 +1,7 @@
 include MANIFEST.in
 include LICENSE.txt
 include README.txt
+include INSTALL.txt
 recursive-include h5py *.py *.pyx *.pxd
 recursive-include h5py *.h *.c *.hdf5
 recursive-include licenses *
diff --git a/README.txt b/README.txt
index 8c75368..fe8533b 100755
--- a/README.txt
+++ b/README.txt
@@ -19,6 +19,7 @@ Contents
 
 * `Introduction`_
 * `Features`_
+* `Installation`_
 * `High-level interface`_
 * `Low-level interface`_
 
@@ -31,23 +32,14 @@ intended to be a complete wrapping of the HDF5 1.6 API, while the high-
 level component supports Python-style object-oriented access to HDF5 files, 
 datasets and groups.
 
-Requires
---------
-- Unix-like environment (created/tested on 32-bit Intel linux)
-- Numpy 1.0.3 or higher
-- HDF5 1.6.5 or higher (1.8 is untested)
-- Pyrex 0.9.6.4 or higher
-
-Installation
-------------
-See the file "INSTALL.txt"
-
 Documentation
 -------------
 Extensive documentation is available through docstrings, as well as in 
-HTML format on the web and in the "docs/" directory in this distribution.  
-This document is an overview of some of the package's features and 
-highlights.
+`HTML format on the web`__ and in the "docs/" directory in this 
+distribution.  This document is an overview of some of the package's 
+features and highlights.
+
+__ http://h5py.alfven.org
 
 Features
 ========
@@ -103,6 +95,41 @@ Features
   no new datatypes; just the built-in Numpy ones.
 
 
+Installation
+============
+Since this is an early release of h5py, only installation from source is
+currently supported.  However, Python's distutils makes this relatively
+painless, assuming you have correctly installed the prerequisite packages.
+If possible, it's strongly recommended you use the versions of these 
+packages provided by your operating system's package manager/finder.
+
+Requires
+--------
+- Unix-like environment (created/tested on 32-bit Intel linux)
+- Numpy_ 1.0.3 or higher
+- HDF5_ 1.6.5 or higher (1.8 is untested)
+- Pyrex_ 0.9.6.4 or higher
+- gcc (to compile Python extensions)
+
+.. _Numpy: http://numpy.scipy.org/
+.. _HDF5: http://hdf.ncsa.uiuc.edu/
+.. _Pyrex: http://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/
+
+Procedure
+---------
+1.  Unpack the tarball and cd to the resulting directory
+2.  Run ``python setup.py build`` to build the package
+3.  Run ``python setup.py test`` to run unit tests (optional)
+4.  Run ``sudo python setup.py install`` to install into your main Python
+    package directory.
+
+Bugs
+----
+I expect there are many. :) A FAQ page will soon be created at the project
+hosting wiki (http://h5py.googlecode.com); check there.  You can open
+a ticket there or email me at "h5py" at the domain "alfven dot org".
+
+
 High-level interface
 ====================
 
diff --git a/setup.py b/setup.py
index 5a797b5..c668ae6 100755
--- a/setup.py
+++ b/setup.py
@@ -91,8 +91,9 @@ class dev(Command):
         pass
 
     def run(self):
-        buildobj = self.distribution.get_command_obj('build')
-        buildobj.run()
+        if self.doc:
+            buildobj = self.distribution.get_command_obj('build')
+            buildobj.run()
         
         if self.doc:
             retval = os.spawnlp(os.P_WAIT, 'epydoc', '-q', '--html', '-o', 'docs/',

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/h5py.git