doc/install.txt

   1 *************
   2 Installing BE
   3 *************
   4
   5 Dependencies
   6 ============
   7
   8 ==============  =======================  ===============  ===========================
   9 Package         Role                     Debian           Gentoo
  10 ==============  =======================  ===============  ===========================
  11 PyYAML_         serialized data storage  python-yaml      dev-python/pyyaml
  12 Sphinx_         see :doc:`doc`           python-sphinx    dev-python/sphinx
  13 numpydoc_       see :doc:`doc`                            dev-python/numpydoc [#npd]_
  14 Docutils_       manpage generation       python-docutils  dev-python/docutils
  15 ==============  =======================  ===============  ===========================
  16
  17 .. [#npd] In the science_ overlay.
  18
  19 .. _PyYAML: http://pyyaml.org/
  20 .. _Sphinx: http://sphinx.pocoo.org/
  21 .. _numpydoc: http://pypi.python.org/pypi/numpydoc
  22 .. _Docutils: http://docutils.sourceforge.net/
  23 .. _science: http://overlays.gentoo.org/proj/science
  24
  25 Git repository
  26 ==============
  27
  28 BE is available as a Git repository::
  29
  30     $ git clone git://gitorious.org/be/be.git be
  31
  32 See the homepage_ for details.  If you do branch the Git repo, you'll
  33 need to run::
  34
  35     $ make
  36
  37 to build some auto-generated files (e.g. :mod:`libbe._version`), and::
  38
  39     $ make install
  40
  41 to install BE.  By default BE will install into your home directory,
  42 but you can tweak the ``PREFIX`` variable in ``Makefile`` to install
  43 to another location.
  44
  45 By default, ``make`` builds both a man page for ``be`` and the HTML
  46 Sphinx documentation (:doc:`doc`).  You can customize the
  47 documentation targets by overriding_ the ``DOC`` variable.  For
  48 example, to disable all documentation during a build/install, run::
  49
  50     $ make DOC= install
  51
  52 Note that ``setup.py`` (called during ``make install``) will install
  53 the man page (``doc/man/be.1``) if it exists, so::
  54
  55     $ make
  56     $ make DOC= install
  57
  58 *will* build (first ``make``) install (second ``make``) the man page.
  59
  60
  61 .. _homepage: http://bugseverywhere.org/
  62 .. _overriding: http://www.gnu.org/software/make/manual/html_node/Overriding.html#Overriding
  63
  64
  65 Release tarballs
  66 ================
  67
  68 For those not interested in the cutting edge, or those who don't want
  69 to worry about installing Git, we'll post release tarballs somewhere
  70 (once we actually make a release).  After you've downloaded the
  71 release tarball, unpack it with::
  72
  73     $ tar -xzvf be-<VERSION>.tar.gz
  74
  75 And install it with:::
  76
  77     $ cd be-<VERSION>
  78     $ make install
  79
  80
  81 Distribution packages
  82 =====================
  83
  84 Some distributions (Debian_ , Ubuntu_ , others?) package BE.  If
  85 you're running one of those distributions, you can install the package
  86 with your regular package manager.  For Debian, Ubuntu, and related
  87 distros, that's::
  88
  89     $ apt-get install bugs-everywhere
  90
  91 However, the official packages can lag behind current development.
  92
  93 .. _Debian: http://packages.debian.org/sid/bugs-everywhere
  94 .. _Ubuntu: http://packages.ubuntu.com/lucid/bugs-everywhere