[Zodb-checkins] CVS: ZODB4 - README.txt:1.2

Jeremy Hylton jeremy@zope.com
Mon, 17 Mar 2003 17:58:15 -0500


Update of /cvs-repository/ZODB4
In directory cvs.zope.org:/tmp/cvs-serv12160

Modified Files:
	README.txt 
Log Message:
Add a little explication.


=== ZODB4/README.txt 1.1 => 1.2 ===
--- ZODB4/README.txt:1.1	Tue Jun 25 13:29:23 2002
+++ ZODB4/README.txt	Mon Mar 17 17:58:15 2003
@@ -1,4 +1,4 @@
-Welcome to the ZODB4 source
+Welcome to ZODB4 release 4.0 alpha 1
 
   ZODB4 is being developed as part of the Zope3 project.  There is
   more developer info in the Zope3 Wiki:
@@ -7,18 +7,22 @@
 
   That's one URL split over two lines.
 
-Building and running tests
+  The ZODB Wiki has more information about the development plans
+  for ZODB4: http://www.zope.org/Wikis/ZODB/ZODB4
 
-  ZODB4 requires Python 2.2 or higher
+  This version of ZODB is not compatible with ZODB3.  The APIs are
+  different and the database formats are different.  Since this is
+  an alpha release, we expect APIs will continue to change.  However,
+  we plan to provide database migration tools for the next version of
+  ZODB; that is, it will be possible to migrate data from a database
+  created with ZODB 4.0a1 to 4.0a2.
 
-  In the top-level ZODB4 directory, you should find a script called
-  build.py.  Run it to build the extension modules needed by
-  ZODB.  Example:
+Building and running tests
 
-  # cd src/ZODB4
-  # python2.2 build.py
+  ZODB4 requires Python 2.2.2 or higher.  It is packaged with
+  distutils.  You can use setup.py to build and install ZODB4.
 
-  ZODB3 includes unit tests based on the Python unittest module.  If
+  ZODB4 includes unit tests based on the Python unittest module.  If
   you checkin changes, you should verify that all the tests succeed
   before you checkin.
 
@@ -27,3 +31,8 @@
 
   Use test.py -h for usage.  The test script can run selected tests,
   stop after the first error, run the tests in a loop, etc.
+
+  The test suite runs 1282 tests in 250 seconds on one development
+  machine.  By default, the test suite skips many tests that cover
+  interactions between components and that take a long time to run.
+  Add the --all option to test.py to run all the tests.