SVN: ZODB/trunk/README.txt Tweaked to reflect current state of install process.
Jim Fulton <[email protected]>
| Newsgroups | gmane.comp.python.zope.zodb.cvs |
|---|---|
| Message-ID | <20090826121522.8164D94181__45340.9769841985$1251288939$gmane$org@cvs.zope.org> |
Log message for revision 103223: Tweaked to reflect current state of install process. Changed: U ZODB/trunk/README.txt -=- Modified: ZODB/trunk/README.txt =================================================================== --- ZODB/trunk/README.txt 2009-08-26 12:15:19 UTC (rev 103222) +++ ZODB/trunk/README.txt 2009-08-26 12:15:22 UTC (rev 103223) @@ -1,5 +1,5 @@ ==== -ZODB +ZODB ==== Introduction @@ -13,7 +13,7 @@ - Standard storages such as FileStorage - The persistent BTrees modules - ZEO, for scalability needs -- documentation (needs more work) +- documentation (needs a lot more work) Our primary development platforms are Linux, Mac OS X, and Windows XP. The test suite should pass without error on all of these @@ -24,7 +24,6 @@ Compatibility ============= - ZODB 3.9 requires Python 2.4.2 or later. ZODB ZEO clients from ZODB 3.2 on can talk to ZODB 3.9 servers. ZODB @@ -33,15 +32,13 @@ Prerequisites ============= -You must have Python installed. If you've installed Python from RPM, -be sure that you've installed the development RPMs too, since ZODB -builds Python extensions. If you have the source release of ZODB, -you will need a C compiler. +You must have Python installed. If you're using a system Python +install, make sure development support is installed too. You also need the transaction, zc.lockfile, ZConfig, zdaemon, zope.event, zope.interface, zope.proxy and zope.testing packages. If -you are using easy_install or zc.buildout to install ZODB, then these -will be installed for you automatically. +you don't have them and you can connect to the Python Package Index, +then these will be installed for you if you don't have them. Installation ============ @@ -55,29 +52,24 @@ zope.interface, zope.proxy and zope.testing. These can be found in the `Python Package Index <http://www.python.org/pypi>`_. -To build it, run the setup script:: +To run the tests, use the test setup command:: - % python setup.py build + python setup.py test -The 64-bit support for the BTrees package may be enabled by using this -build command instead:: +It will download dependencies if needed. If this happens, ou may get +an import error when the test command gets to looking for tests. Try +running the test command a second time and you should see the tests +run. - % python setup.py build_ext -DZODB_64BIT_INTS build +:: -To test the build, run the test script:: + python setup.py test - % python test.py +To install, use the install command:: -For more verbose test output, append one or two '-v' arguments to this -command. + python setup.py install -If all the tests succeeded, you can install ZODB using the setup -script:: - % python setup.py install - -This should now make all of ZODB accessible to your Python programs. - Testing for Developers ======================