aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChris Ball <cjb@laptop.org>2012-01-02 15:43:30 -0500
committerChris Ball <cjb@laptop.org>2012-01-02 15:43:30 -0500
commitf0011cf09d1385f983853b1d11ae5573148139bb (patch)
treedf20d8d032fc4ecf7cd4344c6e4c6262679f90a9 /doc
parentb1527580ece00959b9e9d90e8f0f7dd1bce0342a (diff)
parent6f2d652b2697d7aec6bb48a2bf4d6fff1ef03521 (diff)
downloadbugseverywhere-f0011cf09d1385f983853b1d11ae5573148139bb.tar.gz
Merge http://www.physics.drexel.edu/~wking/code/git/be
Diffstat (limited to 'doc')
-rw-r--r--doc/install.txt8
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/install.txt b/doc/install.txt
index c428087..33d5dae 100644
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -9,6 +9,7 @@ Dependencies
Package Role Debian Gentoo
============== ======================= =============== ===========================
PyYAML_ serialized data storage python-yaml dev-python/pyyaml
+Jinja_ HTML templating python-jinja2 deb-python/jinja
Sphinx_ see :doc:`doc` python-sphinx dev-python/sphinx
numpydoc_ see :doc:`doc` dev-python/numpydoc [#npd]_
Docutils_ manpage generation python-docutils dev-python/docutils
@@ -17,6 +18,7 @@ Docutils_ manpage generation python-docutils dev-python/docutils
.. [#npd] In the science_ overlay.
.. _PyYAML: http://pyyaml.org/
+.. _Jinja: http://jinja.pocoo.org/
.. _Sphinx: http://sphinx.pocoo.org/
.. _numpydoc: http://pypi.python.org/pypi/numpydoc
.. _Docutils: http://docutils.sourceforge.net/
@@ -39,8 +41,10 @@ to build some auto-generated files (e.g. :mod:`libbe._version`), and::
$ make install
to install BE. By default BE will install into your home directory,
-but you can tweak the ``PREFIX`` variable in ``Makefile`` to install
-to another location.
+but you can tweak the ``INSTALL_OPTIONS`` variable in ``Makefile`` to
+install to another location. With the default installation, you may
+need to add ``~/.local/bin/`` to your ``PATH`` so that your shell can
+find the installed ``be`` script.
By default, ``make`` builds both a man page for ``be`` and the HTML
Sphinx documentation (:doc:`doc`). You can customize the