===============
This is Bugs Everywhere (BE), a bugtracker built on distributed version
-control. It works with Arch, Bazaar, Darcs, Git, and Mercurial at the
-moment, but is easily extensible. It can also function with no VCS at
-all.
+control. It works with Arch, Bazaar, Darcs, Git, Mercurial, and Monotone
+at the moment, but is easily extensible. It can also function with no
+VCS at all.
The idea is to package the bug information with the source code, so that
bugs can be marked "fixed" in the branches that fix them. So, instead of
Getting BE
==========
-BE is available as a bzr repository::
+BE is available as a Git repository::
- $ bzr branch http://bzr.bugseverywhere.org/be
+ $ git clone git://gitorious.org/be/be.git be
-See the homepage_ for details. If you do branch the bzr repo, you'll
+See the homepage_ for details. If you do branch the Git repo, you'll
need to run::
$ make
available in the doc directory as reStructuredText_ . You can build
the full documentation with Sphinx_ , convert single files with
docutils_ , or browse through the doc directory by hand.
-doc/index.txt is a good place to start. If you do use Sphinx, you'll
-need to install numpydoc_ for automatically generating API
+``doc/index.txt`` is a good place to start. If you do use Sphinx,
+you'll need to install numpydoc_ for automatically generating API
documentation. See the ``NumPy/SciPy documentation guide``_ for an
introduction to the syntax.
.. _docutils: http://docutils.sourceforge.net/
.. _numpydoc: http://pypi.python.org/pypi/numpydoc
.. _NumPy/SciPy documentation guide:
- http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
+ https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt