diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/narr/install.rst | 24 |
2 files changed, 15 insertions, 15 deletions
diff --git a/docs/index.rst b/docs/index.rst index 1048c95f9..a51a75636 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,8 @@ .. _index: -========================== - repoze.bfg Documentation -========================== +=========== +repoze.bfg +=========== ``repoze.bfg`` is a web application framework based on graph traversal. It is inspired by Zope's publisher, though less ambitious diff --git a/docs/narr/install.rst b/docs/narr/install.rst index a6f5d91e2..bec8217f8 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -5,9 +5,10 @@ How To Install -------------- You will need `Python <http://python.org>`_ version 2.4 or better to -run :mod:`repoze.bfg`. Development of :mod:`repoze.bfg` is done under -Python 2.4, so is recommended. :mod:`repoze.bfg` does *not* run under -any version of Python before 2.4, and does *not* run under Python 3.X. +run :mod:`repoze.bfg`. Development of :mod:`repoze.bfg` is done +primarily under Python 2.4, so that version is recommended. +:mod:`repoze.bfg` does *not* run under any version of Python before +2.4, and does *not* run under Python 3.X. You may install :mod:`repoze.bfg` into your Python environment using the following command:: @@ -17,12 +18,11 @@ the following command:: You will need :term:`setuptools` installed on within your Python system in order to run the ``easy_install`` command. -It is advisable to install :mod:`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 :mod:`repoze.bfg` from -globally installing versions of packages that are not compatible with -your system Python). +It is advisable to install :mod:`repoze.bfg` into a :term:`virtualenv` +in order to obtain isolation from any "system" packages you've got +installed in your Python version (and likewise, to prevent +:mod:`repoze.bfg` from globally installing versions of packages that +are not compatible with your system Python). What Gets Installed ------------------- @@ -31,6 +31,6 @@ When you ``easy_install`` repoze.bfg, various Zope libraries, WebOb, PasteScript, PasteDeploy, PasteScript, and FormEncode libraries are installed. -Additionally, as shown in the next section, Paster templates will ge -registered with your site packages. These templates make starting a -new :mod:`repoze.bfg` project a breeze. +Additionally, as shown in the next section, PasteScript (aka *paster*) +templates will be registered that make it easy to start a new +:mod:`repoze.bfg` project. |