diff options
| author | Paul Everitt <paul@agendaless.com> | 2008-07-24 19:56:57 +0000 |
|---|---|---|
| committer | Paul Everitt <paul@agendaless.com> | 2008-07-24 19:56:57 +0000 |
| commit | e655101482993bde561d49d9bf87d170e8a3a642 (patch) | |
| tree | 24da6b42826f81eb5c770fa67a88d03bb21894df /docs/narr/install.rst | |
| parent | 932675884332070229ee5ada2c163f5e218fdb72 (diff) | |
| download | pyramid-e655101482993bde561d49d9bf87d170e8a3a642.tar.gz pyramid-e655101482993bde561d49d9bf87d170e8a3a642.tar.bz2 pyramid-e655101482993bde561d49d9bf87d170e8a3a642.zip | |
Change more occurrences to mod:repoze
Diffstat (limited to 'docs/narr/install.rst')
| -rw-r--r-- | docs/narr/install.rst | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/docs/narr/install.rst b/docs/narr/install.rst index 2e7ae9ffb..a6f5d91e2 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -1,30 +1,28 @@ -Installing ``repoze.bfg`` -========================= +Installing :mod:`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 +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. -You may install ``repoze.bfg`` into your Python environment using the -following command:: +You may install :mod:`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. +You will need :term:`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 +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 ``repoze.bfg`` from globally -installing versions of packages that are not compatible with your -system Python). +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 ------------------- @@ -33,3 +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. |