[Zodb-checkins] SVN: ZODB/branches/3.8/ Added the README.txt and NEWS.txt to the long_description

[Christophe Combelles]

Log message for revision 92035:
  Added the README.txt and NEWS.txt to the long_description
  

Changed:
  U   ZODB/branches/3.8/README.txt
  U   ZODB/branches/3.8/setup.py

-=-
Modified: ZODB/branches/3.8/README.txt
===================================================================
--- ZODB/branches/3.8/README.txt	2008-10-11 12:17:30 UTC (rev 92034)
+++ ZODB/branches/3.8/README.txt	2008-10-11 13:17:18 UTC (rev 92035)
@@ -1,6 +1,10 @@
+
 ZODB 3.8
 ========
 
+.. contents::
+
+
 Introduction
 ------------
 
@@ -11,8 +15,8 @@
 - Core ZODB, including the persistence machinery
 - Standard storages such as FileStorage
 - The persistent BTrees modules
-- ZEO
-- documentation (poor)
+- ZEO, for scalability needs
+- documentation (needs 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
@@ -81,7 +85,7 @@
 Testing for Developers
 ----------------------
 
-The ZODB check outs are `buldouts <http://www.python.org/pypi/zc.buildout>`_.
+The ZODB checkouts are `buildouts <http://www.python.org/pypi/zc.buildout>`_.
 When working from a ZODB checkout, first run the bootstrap.py script
 to initialize the buildout:
 
@@ -115,6 +119,15 @@
     OK
 
 
+Maintenance scripts
+-------------------
+
+Several scripts are provided with the ZODB and can help for analyzing,
+debugging, checking for consistency, summarizing content, reporting space used
+by objects, doing backups, artificial load testing, etc.
+Look at the ZODB/script directory for more informations.
+
+
 History
 -------
 
@@ -148,9 +161,7 @@
 StandaloneZODB is a bit of a mouthful.  The standalone part of the
 name suggests that the Zope version is the real version and that this
 is an afterthought, which isn't the case.  So we're calling this
-release "ZODB".
-
-To make matters worse, we worked on a ZODB4 package for a while and
+release "ZODB". We also worked on a ZODB4 package for a while and
 made a couple of alpha releases.  We've now abandoned that effort,
 because we didn't have the resources to pursue ot while also maintaining
 ZODB(3).
@@ -201,10 +212,9 @@
 Bugs and Patches
 ----------------
 
-Bug reports and patches should be added to the Zope Collector, with
-topic "Database":
+Bug reports and patches should be added to the Launchpad:
 
-    http://collector.zope.org/Zope
+    https://launchpad.net/zodb
 
 
 ..

Modified: ZODB/branches/3.8/setup.py
===================================================================
--- ZODB/branches/3.8/setup.py	2008-10-11 12:17:30 UTC (rev 92034)
+++ ZODB/branches/3.8/setup.py	2008-10-11 13:17:18 UTC (rev 92035)
@@ -245,7 +245,8 @@
         self.cmdclass['build_py'] = MyPyBuilder
         self.cmdclass['install_lib'] = MyLibInstaller
 
-doclines = __doc__.split("\n")
+def read(*rnames):
+    return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
 
 
 setup(name="ZODB3",
@@ -260,8 +261,13 @@
                  'src/persistent/ring.h'],
       license = "ZPL 2.1",
       platforms = ["any"],
-      description = doclines[0],
+      description = __doc__.split("\n")[0],
       classifiers = filter(None, classifiers.split("\n")),
-      long_description = "\n".join(doclines[2:]),
+      long_description = (
+            __doc__
+            + read('README.txt')
+            + '\n\n'
+            + read('NEWS.txt')
+            ),
       distclass = MyDistribution,
       **extra)