[Checkins] SVN: five.customerize/trunk/ Some docs

Sun Oct 29 19:14:30 EST 2006

Log message for revision 70977:
  Some docs
  

Changed:
  U   five.customerize/trunk/CHANGES.txt
  U   five.customerize/trunk/INSTALL.txt
  U   five.customerize/trunk/README.txt

-=-
Modified: five.customerize/trunk/CHANGES.txt
===================================================================

--- five.customerize/trunk/CHANGES.txt	2006-10-29 23:59:49 UTC (rev 70976)
+++ five.customerize/trunk/CHANGES.txt	2006-10-30 00:14:30 UTC (rev 70977)
@@ -1,32 +1,7 @@
-zope.XXX Package Changelog
-==========================
+CHANGES
+=======
 
-zope.XXX version 3.2.1 (2006/03/26)
------------------------------------
+five.customerize 0.1 (2006/10/30)
+---------------------------------
 
-- Corresponds to the verison of the zope.XXX package shipped as part of
-  the Zope 3.2.1 release.
-
-zope.XXX version 3.2.0 (2006/01/05)
------------------------------------
-
-- Corresponds to the verison of the zope.XXX package shipped as part of
-  the Zope 3.2.0 release.
-
-zope.XXX version 3.1.0 (2005/10/03)
------------------------------------
-
-- Corresponds to the verison of the zope.XXX package shipped as part of
-  the Zope 3.1.0 release.
-
-zope.XXX version 3.0.1 (2005/07/27)
------------------------------------
-
-- Corresponds to the verison of the zope.XXX package shipped as part of
-  the Zope X3.0.1 release.
-
-zope.XXX version 3.0.0 (2004/11/07)
------------------------------------
-
-- Corresponds to the verison of the zope.XXX package shipped as part of
-  the Zope X3.0.0 release.
+Initial version

Modified: five.customerize/trunk/INSTALL.txt
===================================================================
--- five.customerize/trunk/INSTALL.txt	2006-10-29 23:59:49 UTC (rev 70976)
+++ five.customerize/trunk/INSTALL.txt	2006-10-30 00:14:30 UTC (rev 70977)
@@ -4,80 +4,35 @@
 Prerequisites
 -------------
 
-The installation steps below assume that you have the cool new 'setuptools'
-package installed in your Python.  Here is where to get it:
+* Zope 2.10.x
 
-  $ wget http://peak.telecommunity.com/dist/ez_setup.py
-  $ /path/to/your/python ez_setup.py # req. write access to 'site-packages'
+* setuptools
 
 
-  - Docs for EasyInstall:
-    http://peak.telecommunity.com/DevCenter/EasyInstall
+Installation
+------------
 
-  - Docs for setuptools:
-    http://peak.telecommunity.com/DevCenter/setuptools
+Place the ``five`` top-level package into your instance's
+``lib/python`` directory.  You can also install it as an egg using
+ez_install, for example into your instance by turning it into a
+workingenv.
 
-  - Docs for eggs:
-    http://peak.telecommunity.com/DevCenter/PythonEggs
 
+Configuration
+-------------
 
-Installing a Development Checkout
----------------------------------
+Place a ``five.customerize-configure.zcml`` file into your instance's
+``etc/package-includes`` directory with the following contents::
 
-Check out the package from subversion:
+  <include package="five.customerize" />
 
-  $ svn co svn+ssh://svn.zope.org/repos/main/zope.XXX/trunk \
-    src/zope.XXX
-  $ cd src/zope.XXX
+Alternatively, you can also add this line to the bottom of
+``etc/site.zcml``.
 
-Install it as a "devlopment egg" (which also installs its "hard"
-dependencies):
 
-  $ /path/to/your/python setup.py devel
-
-The installation of dependency eggs uses the 'setup.cfg' file in
-the checkout.  You can supply '--find-links' on the command line to
-point it at a non-standard package repository.
-
-
 Running the Tests
 -----------------
 
-To test the package, you will also need the 'zope.testing' package, which
-can't (yet) be automatically installed.  Eventually, you should be able to
-type:
+Use the following command to run this package's tests:
 
-  $ /path/to/your/python setup.py test
-
-and have it install the "testing dependencies."  Today, the workaround
-is to install it manually:
-
-  $ /path/to/easy_install --find-links="...." zope.testing
-
-You can then run the tests (finally) from the checkout directory:
-
-  $ /path/to/your/python test.py
-    Running:
-      .............
-    Ran 13 tests with 0 failures and 0 errors in 0.094 seconds.
-
-
-Installing a Source Distribution
---------------------------------
-
-You can also install it from a source distribution:
-
-  $ /path/to/easy_install --find-links="...." -eb src zope.XXX
-  $ cd src/zope.XXX
-  $ /path/to/your/python setup.py devel
-
-
-Installing a Binary Egg
------------------------
-
-Install the package as a "binary egg" (which also installs its "hard"
-dependencies):
-
-  $ /path/to/easy_install --find-links="...." zope.XXX
-
-
+  $ bin/zopectl test -s five.customerize

Modified: five.customerize/trunk/README.txt
===================================================================
--- five.customerize/trunk/README.txt	2006-10-29 23:59:49 UTC (rev 70976)
+++ five.customerize/trunk/README.txt	2006-10-30 00:14:30 UTC (rev 70977)
@@ -1,10 +1,12 @@
-zope.XXX Package Readme
-=======================
+five.customerize
+================
 
 Overview
 --------
 
-Lorem ipsum delorem.
+``five.customerize`` provides the ability to locally customize Page
+Template-based browser views, much like it is possible to customize
+file-system based view templates in the CMF's portal_skin tools.
 
 Changes
 -------
@@ -16,22 +18,17 @@
 
 See INSTALL.txt.
 
-
 Developer Resources
 -------------------
 
 - Subversion browser:
 
-  http://svn.zope.org/zope.XXX/
+  http://svn.zope.org/five.customerize
 
 - Read-only Subversion checkout:
 
-  $ svn co svn://svn.zope.org/repos/main/zope.XXX/trunk
+  $ svn co svn://svn.zope.org/repos/main/five.customerize/trunk
 
 - Writable Subversion checkout:
 
-  $ svn co svn://svn.zope.org/repos/main/zope.XXX/trunk
-
-- Note that the 'src/zope/XXX' package is acutally a 'svn:externals' link
-  to the corresponding package in the Zope3 trunk (or to a specific tag,
-  for released versions of the package).
+  $ svn co svn+ssh://svn.zope.org/repos/main/five.customerize/trunk

