source: products/quintagroup.plonecomments/trunk/docs/INSTALL.txt @ 987

Last change on this file since 987 was 987, checked in by crchemist, 17 years ago

Fix overrides.zcml

File size: 2.5 KB
RevLine 
[982]1===========================
2Installation/Uninstallation
3===========================
[820]4
[982]5Installation
6==============
7
[820]8To install quintagroup.plonecomments into the global Python environment (or a workingenv),
9using a traditional Zope 2 instance, you can do this:
10
[982]11- When you're reading this you have probably already run
[820]12  ``easy_install quintagroup.plonecomments``. Find out how to install setuptools
13  (and EasyInstall) here:
14  http://peak.telecommunity.com/DevCenter/EasyInstall
15
[982]16- If you are using Zope 2.9 (not 2.10), get `pythonproducts`_ and install it
[820]17  via::
18
19    python setup.py install --home /path/to/instance
20
21into your Zope instance.
22
[982]23- Create a file called ``quintagroup.plonecomments-configure.zcml`` in the
[820]24  ``/path/to/instance/etc/package-includes`` directory.  The file
25  should only contain this::
26
[966]27    <include package="quintagroup.plonecomments" file="configure.zcml" />
[820]28
[982]29- Create a file called ``quintagroup.plonecomments-overrides.zcml`` in the
[966]30  ``/path/to/instance/etc/package-includes`` directory.  The file
31  should only contain this::
32
33    <include package="quintagroup.plonecomments" file="overrides.zcml" />
34
[820]35.. _pythonproducts: http://plone.org/products/pythonproducts
36
37Alternatively, if you are using zc.buildout and the plone.recipe.zope2instance
38recipe to manage your project, you can do this:
39
[982]40- Add ``quintagroup.plonecomments`` to the list of eggs to install, e.g.::
[820]41
42    [buildout]
43    ...
44    eggs =
45        ...
46        quintagroup.plonecomments
47       
[982]48- Tell the plone.recipe.zope2instance recipe to install a ZCML slug::
[820]49
50    [instance]
51    recipe = plone.recipe.zope2instance
52    ...
53    zcml =
54        quintagroup.plonecomments
[966]55        quintagroup.plonecomments-overrides
[820]56     
[982]57- Re-run buildout, e.g. with::
[820]58
59    $ ./bin/buildout
[966]60
[987]61- Install quintagroup.plonecomments via ZMI portal_setup. Select ``quintagroup.plonecomments``
[966]62  from the list of available profiles and press *Import all steps*.
63
64  **Atention**: If you are using a Plone version **before** 3.1 you need to install
65  "plone.browserlayer":http://pypi.python.org/pypi/plone.browserlayer (which also
66  requires a "GenericSetup":http://pypi.python.org/pypi/Products.GenericSetup version
67  greater than 1.4) in your Plone site. It shows up as **Local browser layer support**
68  in the Plone Add-on Products Control Panel.
69
[982]70
[966]71Uninstallation
[982]72==============
[966]73
[982]74- To uninstall quintagroup.plonecomments - select ``quintagroup.plonecomments uninstall``
[966]75  profile from the list of available profiles and press *Import all steps*.
Note: See TracBrowser for help on using the repository browser.