diff options
| author | Chris McDonough <chrism@agendaless.com> | 2008-07-21 01:19:01 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2008-07-21 01:19:01 +0000 |
| commit | 102d19d261af83c8dc9f619fe95d1a62ffb195dd (patch) | |
| tree | ec5a448977794867b32aaaecb888070677137712 | |
| parent | 0bc787d4999460d4219c621f83c619ca7c4552c2 (diff) | |
| download | pyramid-102d19d261af83c8dc9f619fe95d1a62ffb195dd.tar.gz pyramid-102d19d261af83c8dc9f619fe95d1a62ffb195dd.tar.bz2 pyramid-102d19d261af83c8dc9f619fe95d1a62ffb195dd.zip | |
Add install docs.
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/narr/install.rst | 35 | ||||
| -rw-r--r-- | docs/narr/introduction.rst | 4 |
3 files changed, 38 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst index f7bf25bd0..86b524120 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,7 @@ Narrative documentation in chapter form explaining how to use :maxdepth: 2 narr/introduction + narr/install narr/project narr/traversal narr/views diff --git a/docs/narr/install.rst b/docs/narr/install.rst new file mode 100644 index 000000000..2e7ae9ffb --- /dev/null +++ b/docs/narr/install.rst @@ -0,0 +1,35 @@ +Installing ``repoze.bfg`` +========================= + +How To Install +-------------- + +You will need `Python <http://python.org>`_ version 2.4 or better to +run ``repoze.bfg``. Development of ``repoze.bfg`` is done under +Python 2.4, so is recommended. ``repoze.bfg`` does *not* run under +any version of Python before 2.4, and does *not* run under Python 3.X. + +You may install ``repoze.bfg`` into your Python environment using the +following command:: + + $ easy_install -i http://dist.repoze.org/lemonade/dev/simple repoze.bfg + +You will need `Setuptools +<http://peak.telecommunity.com/DevCenter/setuptools>`_ installed on +within your Python system in order to run the ``easy_install`` +command. + +It is advisable to install ``repoze.bfg`` into a `virtualenv +<http://pypi.python.org/pypi/virtualenv>`_ in order to obtain +isolation from any "system" packages you've got installed in your +Python version (and likewise, to prevent ``repoze.bfg`` from globally +installing versions of packages that are not compatible with your +system Python). + +What Gets Installed +------------------- + +When you ``easy_install`` repoze.bfg, various Zope libraries, WebOb, +PasteScript, PasteDeploy, PasteScript, and FormEncode libraries are +installed. + diff --git a/docs/narr/introduction.rst b/docs/narr/introduction.rst index 438e4008b..6c6f0de62 100644 --- a/docs/narr/introduction.rst +++ b/docs/narr/introduction.rst @@ -1,5 +1,5 @@ -repoze.bfg Introduction -======================= +``repoze.bfg`` Introduction +=========================== ``repoze.bfg`` is a web application framework based on graph traversal. It is inspired by Zope's publisher, and uses Zope |