[Zodb-checkins] CVS: StandaloneZODB - README:1.1.4.4

[Barry Warsaw]

Update of /cvs-repository/StandaloneZODB
In directory cvs.zope.org:/tmp/cvs-serv16975

Modified Files:
      Tag: StandaloneZODB-1_0-branch
	README 
Log Message:
Added instructions on how to build the Berkeley DB libraries.  Will
have to double check for the 1.0 release.

Also, note that StandaloneZODB doesn't work with Python 2.0 or
earlier, and likely never will.


=== StandaloneZODB/README 1.1.4.3 => 1.1.4.4 ===
 
     StandaloneZODB is known to work with with all Python versions from
-    Python 2.1 to Python 2.2.  It may or may not work with versions
-    earlier than Python 2.1.  Our primary development platform is
-    Linux, but everything should work on most Un*x platforms, and
-    we've tested this distribution on Windows with the Python 2.2
-    final release (it may or may not work on Windows with earlier
-    Python releases).
+    Python 2.1 to Python 2.2.  It probably will not work with any
+    version earlier than Python 2.1, and we have no plans to support
+    earlier versions.  Our primary development platform is Linux, but
+    everything should work on most Un*x platforms, and we've tested
+    this distribution on Windows with the Python 2.2 final release (it
+    may or may not work on Windows with earlier Python releases).
 
     The components you get with the StandaloneZODB release are as follows:
 
@@ -27,6 +27,45 @@
 	- ZEO
 	- Experimental Berkeley storages
 	- Some documentation <wink>
+
+Prerequisites
+
+    You must have Python installed.  We recommend either Python 2.1.2
+    or Python 2.2.  If you've installed Python from RPM, be sure that
+    you've installed the development RPMs too, since StandaloneZODB
+    builds Python extensions.
+
+    If you intend to use the experimental Berkeley storages, you will
+    need to install both the Sleepycat libraries, and PyBSDDB, the
+    next generation of Berkeley DB Python wrapper.  StandaloneZODB
+    will not work with versions of Berkeley DB earlier than 3.3.x and
+    it will not work with the Berkeley DB wrapper that comes standard
+    with Python.
+
+    (Windows users, skip ahead...)
+
+    If you are on Linux or other Un*x-like operating system, start by
+    going to www.sleepycat.com and downloading the Berkeley DB source
+    release.  As of this writing, we recommend that you use Berkeley
+    DB 3.3.11 which was the last release of the 3.x series.  (We
+    haven't yet verified that everything works with Berkeley DB
+    4.0.14.)  Follow the install instructions in the Sleepycat
+    documentation.  We recommend that you install in the default
+    location, i.e. /usr/local/BerkeleyDB.3.3
+
+    Next, go to pybsddb.sf.net and download the PyBSDDB package,
+    a.k.a. bsddb3.  As of this writing, PyBSDDB version 3.3.0 is the
+    latest and this is known to work with Berkeley DB 3.3.11.
+    PyBSDDB is a Python distutils package, however it can be a bit
+    tricky to install.  Here's the sequence that I recommend (works if
+    you've installed Berkeley DB in the default location):
+
+    % python setup.py build_ext --inplace --berkeley-db=/usr/local/BerkeleyDB.3.3 --lflags="-Xlinker -rpath -Xlinker /stuff/BerkeleyDB.3.3/lib"
+    % python setup.py install --berkeley-db=/usr/local/BerkeleyDB.3.3 --lflags="-Xlinker -rpath -Xlinker /stuff/BerkeleyDB.3.3/lib"
+
+    Windows users, you need only download the PyBSDDB file
+    bsddb3-3.3.0.win32-py2.1.exe and install it.  This comes with the
+    requisite Berkeley dlls.
 
 Installation