summaryrefslogtreecommitdiffstats
path: root/docs/INSTALL.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/INSTALL.txt')
-rw-r--r--docs/INSTALL.txt52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/INSTALL.txt b/docs/INSTALL.txt
new file mode 100644
index 0000000..db6e670
--- /dev/null
+++ b/docs/INSTALL.txt
@@ -0,0 +1,52 @@
+fedoratheme.kindofblue Installation
+==========================
+
+To install fedoratheme.kindofblue 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 fedoratheme.kindofblue``. 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 ``fedoratheme.kindofblue-configure.zcml`` in the
+ ``/path/to/instance/etc/package-includes`` directory. The file
+ should only contain this::
+
+ <include package="fedoratheme.kindofblue" />
+
+.. _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 ``fedoratheme.kindofblue`` to the list of eggs to install, e.g.:
+
+ [buildout]
+ ...
+ eggs =
+ ...
+ fedoratheme.kindofblue
+
+ * Tell the plone.recipe.zope2instance recipe to install a ZCML slug:
+
+ [instance]
+ recipe = plone.recipe.zope2instance
+ ...
+ zcml =
+ fedoratheme.kindofblue
+
+ * 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.