Skip to content

Commit

Permalink
Fix INSTALL.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
avoinea committed Jul 16, 2015
1 parent bb7e5f5 commit dcf3873
Showing 1 changed file with 51 additions and 3 deletions.
54 changes: 51 additions & 3 deletions docs/INSTALL.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,52 @@
eea.translations Installation
=======================
EEA Faceted Navigation Installation
-----------------------------------

To be completed ...
To install eea.facetednavigation 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 eea.facetednavigation``. 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 ``eea.facetednavigation-configure.zcml`` in the
``/path/to/instance/etc/package-includes`` directory. The file
should only contain this::

<include package="eea.facetednavigation" />

.. _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 ``eea.facetednavigation`` to the list of eggs to install, e.g.:

[buildout]
...
eggs =
...
eea.facetednavigation

* Tell the plone.recipe.zope2instance recipe to install a ZCML slug:

[instance]
recipe = plone.recipe.zope2instance
...
zcml =
eea.facetednavigation

* 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.

0 comments on commit dcf3873

Please sign in to comment.