From 4281307dfa317ff8d5a78367f50d5fa642e287c8 Mon Sep 17 00:00:00 2001 From: Michael Howitz Date: Fri, 30 Nov 2018 10:34:42 +0100 Subject: [PATCH] Include installation instructions in the README. They were quite invisible in the docs folder. --- README.rst | 46 +++++++++++++++++++++++++++++++++++++++++++++- docs/INSTALL.txt | 43 ------------------------------------------- 2 files changed, 45 insertions(+), 44 deletions(-) delete mode 100644 docs/INSTALL.txt diff --git a/README.rst b/README.rst index ee817f6..bf5293f 100644 --- a/README.rst +++ b/README.rst @@ -27,7 +27,51 @@ It uses the ZCML configuration machinery to ensure that patches are loaded "late" in the startup cycle, so that the original code has had time to be fully initialised and configured. This is similar to using the `initialize()` method in a product's __init__.py, except it does not require that the package -be a full-blown Zope 2 product with a persistent Control_Panel entry. +be a full-blown Zope product with a persistent Control_Panel entry. + + +Installation +============ + +To install `collective.monkeypatcher` into the global Python environment +(or a working environment), using a traditional Zope instance, you can do this: + +* When you're reading this you have probably already run + ``pip install collective.monkeypatcher``. + +* Create a file called ``collective.monkeypatcher-configure.zcml`` in the + ``/path/to/instance/etc/package-includes`` directory. The file + should only contain this:: + + + + +Alternatively, if you are using `zc.buildout` and the +`plone.recipe.zope2instance` recipe to manage your project, you can do this: + +* Add ``collective.monkeypatcher`` to the list of eggs to install, e.g.:: + + [buildout] + ... + eggs = + ... + collective.monkeypatcher + +* Tell the plone.recipe.zope2instance recipe to install a ZCML slug:: + + [instance] + recipe = plone.recipe.zope2instance + ... + zcml = + collective.monkeypatcher + +* 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. + Applying a monkey patch ======================= diff --git a/docs/INSTALL.txt b/docs/INSTALL.txt deleted file mode 100644 index 01a9c5d..0000000 --- a/docs/INSTALL.txt +++ /dev/null @@ -1,43 +0,0 @@ -collective.monkeypatcher Installation -------------------------------------- - -To install collective.monkeypatcher 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 collective.monkeypatcher``. Find out how to install setuptools - (and EasyInstall) here: - http://peak.telecommunity.com/DevCenter/EasyInstall - -* Create a file called ``collective.monkeypatcher-configure.zcml`` in the - ``/path/to/instance/etc/package-includes`` directory. The file - should only contain this:: - - - - -Alternatively, if you are using zc.buildout and the plone.recipe.zope2instance -recipe to manage your project, you can do this: - -* Add ``collective.monkeypatcher`` to the list of eggs to install, e.g.: - - [buildout] - ... - eggs = - ... - collective.monkeypatcher - -* Tell the plone.recipe.zope2instance recipe to install a ZCML slug: - - [instance] - recipe = plone.recipe.zope2instance - ... - zcml = - collective.monkeypatcher - -* 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.