add policy and theme products

[zope-bootstrap.git] / src / koehsel.policy / docs / INSTALL.txt

diff --git a/src/koehsel.policy/docs/INSTALL.txt b/src/koehsel.policy/docs/INSTALL.txt
new file mode 100644 (file)
index 0000000..320bb39
--- /dev/null
+++ b/src/koehsel.policy/docs/INSTALL.txt
@@ -0,0 +1,52 @@
+koehsel.policy Installation
+---------------------------
+
+To install koehsel.policy into the global Python environment (or a workingenv),
+using a traditional Zope 2 instance, you can do this:
+
+* When you're reading this you have probably already run 
+  ``easy_install koehsel.policy``. Find out how to install setuptools
+  (and EasyInstall) here:
+  http://peak.telecommunity.com/DevCenter/EasyInstall
+
+* If you are using Zope 2.9 (not 2.10), get `pythonproducts`_ and install it 
+  via::
+
+    python setup.py install --home /path/to/instance
+
+into your Zope instance.
+
+* Create a file called ``koehsel.policy-configure.zcml`` in the
+  ``/path/to/instance/etc/package-includes`` directory.  The file
+  should only contain this::
+
+    <include package="koehsel.policy" />
+
+.. _pythonproducts: http://plone.org/products/pythonproducts
+
+
+Alternatively, if you are using zc.buildout and the plone.recipe.zope2instance
+recipe to manage your project, you can do this:
+
+* Add ``koehsel.policy`` to the list of eggs to install, e.g.:
+
+    [buildout]
+    ...
+    eggs =
+        ...
+        koehsel.policy
+       
+* Tell the plone.recipe.zope2instance recipe to install a ZCML slug:
+
+    [instance]
+    recipe = plone.recipe.zope2instance
+    ...
+    zcml =
+        koehsel.policy
+      
+* Re-run buildout, e.g. with:
+
+    $ ./bin/buildout
+        
+You can skip the ZCML slug if you are going to explicitly include the package
+from another package's configure.zcml file.