[h5py] 233/455: Update install docs

[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 9677665be165e21361d5c63f856200cace9ab70a
Author: andrewcollette <andrew.collette at gmail.com>
Date:   Wed Feb 18 23:06:24 2009 +0000

    Update install docs
---
 INSTALL.txt                 |  8 +++++++-
 docs/source/guide/build.rst | 25 +++++++++++++++----------
 2 files changed, 22 insertions(+), 11 deletions(-)

diff --git a/INSTALL.txt b/INSTALL.txt
index 14461fd..e8002b5 100644
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -13,7 +13,13 @@ Before you start
 
 You will first need to install HDF5, preferably via a package manager.  Both
 versions 1.6 and 1.8 are supported.  NumPy 1.0.3 (numpy.scipy.org) or later
-is also required.
+is also required. Keep in mind:
+
+1. You will also need headers for development; sometimes this is offered
+   separately as "libhdf5-dev" or similar.
+
+2. HDF5 *must* be available as a dynamic library (libhdf5.so or similar), or
+   h5py won't work.
 
 
 Quick installation
diff --git a/docs/source/guide/build.rst b/docs/source/guide/build.rst
index 67386e0..32388d9 100644
--- a/docs/source/guide/build.rst
+++ b/docs/source/guide/build.rst
@@ -16,19 +16,24 @@ Getting HDF5
 ============
 
 On Windows, HDF5 is provided as part of the integrated
-installer for h5py.  On Linux and OS-X, you
-must provide HDF5 yourself.  HDF5 versions **1.6.5** through **1.8.2** are
-supported.
+installer for h5py.  
 
-**The best solution for both Linux and OS-X is to install HDF5 via a
-package manager.** If you decide to build HDF5 from source, be sure to
-build it as a dynamic library.
+On Linux and OS-X, you must provide HDF5 yourself.  HDF5 versions **1.6.5**
+through **1.8.2** are supported. **The best solution is
+to install HDF5 via a package manager like apt, yum or fink.** Regardless of
+how you decide to install HDF5, keep the following in mind:
 
-`The HDF Group`__ provides several "dumb" (untar in **/**) binary distributions
-for Linux, but traditionally only static libraries for Mac.  Mac OS-X users
-should use something like Fink, or compile HDF5 from source.
+* You'll need the development headers in addition to the library; sometimes
+  package managers list this separately as ``libhdf5-dev`` or similar.
 
-__ http://www.hdfgroup.com/HDF5
+* HDF5 **must** be available as a shared library (``libhdf5.so.X``), or
+  programs like h5py can't work.  In particular, the "static" distribution
+  available from the HDF Group web site **will not work**.
+
+* If you've manually installed one of the SZIP-aware builds from the HDF Group
+  web site, be sure to also install the SZIP libraries.
+
+The HDF Group downloads are located at http://www.hdfgroup.com/HDF5 .
 
 
 .. _windows:

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