[z3-checkins] r5697 - in z3/Five/branch/faassen-docfixes: . tests

[faassen at codespeak.net]

Author: faassen
Date: Mon Jul 26 16:21:00 2004
New Revision: 5697

Modified:
   z3/Five/branch/faassen-docfixes/INSTALL.txt
   z3/Five/branch/faassen-docfixes/tests/README.txt
Log:
Updated install documentation.


Modified: z3/Five/branch/faassen-docfixes/INSTALL.txt
==============================================================================
--- z3/Five/branch/faassen-docfixes/INSTALL.txt	(original)
+++ z3/Five/branch/faassen-docfixes/INSTALL.txt	Mon Jul 26 16:21:00 2004
@@ -1,15 +1,25 @@
 How to install Five
 -------------------
 
+Requirements for Five 0.1
+=========================
+
+* Zope 2.7.x with python 2.3.x
+
+* Zope X3.0.0 Beta 2
+
+Installing Five
+===============
+
 Installing Five is relatively straightforward. 
 
-* You need a Zope 2.7 instance.
+* Select a Zope 2.7 instance.
 
-* You also need an installation of Zope 3. Later on we may produce a
-  Five-specific distribution of the Zope 3 components that are needed,
-  but for now just use Zope 3. You can install it by typing 'make'.
+* Download and install Zope X3.00 Beta 2. You can compile its C code
+  by typing ``make``. On windows it is easier to use a binary release
+  of Zope X3 instead.
 
-* You need to make your Zope 2.7 instance aware of Zope 3 it can
+* You need to make your Zope 2.7 instance aware of Zope 3 so it can
   import packages from it. To do this, go to the etc/zope.conf of your
   Zope 2.7 instance and add a ``path`` entry to your Zope 3's ``src``
   directory, i.e.::
@@ -19,6 +29,11 @@
 * Next, install the Five product into your Zope 2.7 instance as a
   product and restart Zope. Five should now be installed.
 
-* You can also install ``demo/FiveDemo`` and
-  ``demo/FiveViewsDemo``. For more about what these demos, see
-  ``README.txt``.
+* You can also install various products in the ``demo`` subdirectory of
+  Five by copying them into your ``Products`` directory.
+
+Installing the tests
+====================
+
+For information on how to install the automatic Five tests, please see
+``tests/README.txt``.

Modified: z3/Five/branch/faassen-docfixes/tests/README.txt
==============================================================================
--- z3/Five/branch/faassen-docfixes/tests/README.txt	(original)
+++ z3/Five/branch/faassen-docfixes/tests/README.txt	Mon Jul 26 16:21:00 2004
@@ -1,13 +1,16 @@
-How to run the tests:
+Five tests
+==========
 
-The tests need all products in the tests/products subdirectory installed
-in your Zope instance's Products directory. On unixy systems, this can
-be most simply done by a symlink::
+The tests need all products in the ``tests/products`` subdirectory
+installed in your Zope instance's Products directory. On unixy
+systems, this can be most simply done by a symlink::
 
   cd myinstance/Products
   ln -s Five/tests/products/FiveTest .
 
-and so on for each product in tests/products.
+and so on for each product in tests/products. On other platforms, you
+could manually copy these directories (though you'd need to do that
+each time you change the tests).
 
 The tests also require ZopeTestCase to be installed. ZopeTestCase can
 be downloaded from here:
@@ -18,11 +21,11 @@
 directory.
 
 Finally, to run the tests you need to set the following environment
-variables:
+variables::
 
   export INSTANCE_HOME=/path/to/instance
   export SOFTWARE_HOME=/path/to/software/lib/python
 
-Then you should be able to run the tests by typing:
+Then you should be able to run the tests by typing::
 
   python2.3 test_five.py