[z3-checkins] r26782 - z3/sqlos/trunk/src/sqlos

[jinty at codespeak.net]

Author: jinty
Date: Fri May  5 05:53:00 2006
New Revision: 26782

Modified:
   z3/sqlos/trunk/src/sqlos/README.txt
Log:
Add an installation section to the README.

Modified: z3/sqlos/trunk/src/sqlos/README.txt
==============================================================================
--- z3/sqlos/trunk/src/sqlos/README.txt	(original)
+++ z3/sqlos/trunk/src/sqlos/README.txt	Fri May  5 05:53:00 2006
@@ -50,7 +50,7 @@
 ------------ --------
 .            Zope 3.2
 ============ ========
-sqlos 0.2       X
+sqlos 0.2.x     X
 ============ ========
 
 .. _FiveSQLOS: http://codespeak.net/svn/z3/sqlos/trunk/Zope2/FiveSQLOS/
@@ -121,6 +121,37 @@
 connection and any registered class you wish.
 
 
+Installation
+------------
+
+Zope3
+_____
+
+You can easily install sqlos from the python cheeseshop using easy_install.
+To do this, you will have to first install setuptools_.
+
+For example, this command will install sqlos and it's dependencies in
+~/lib/python2.4/site-packages. Note that ~/lib/python2.4/site-packages should
+be on the python path.
+
+    $ easy_install --install-dir=~/lib/python2.4/site-packages 'sqlos == 0.2'
+
+After that, you should install the Zope Database Adapter you wish to use and
+copy the sqlos-*.zcml package includes (in the includes directory in the
+tarball) to the package-includes directory of your Zope instance.
+
+NOTE: the sqlos.ftesting-configure.zcml shouldn't be copied unless you want
+      to test the sample application.
+
+
+Zope2
+_____
+
+Same as for Zope3 above, except you do not have to setup the zcml package
+includes. However, you do need to install the FiveSQLOS Zope2 product. This can
+be found in the Zope2 directory in the tarball.
+
+
 A Sample Application
 --------------------
 
@@ -147,6 +178,7 @@
 NOTE: changing debug=1 in src/sqlos/adapter.py will cause the SQL
       executed to be printed on the terminal
 
+
 Setting up a connection for SQLObject
 -------------------------------------