1  Bugs Everywhere
 2  ===============
 3  
 4  This is Bugs Everywhere (BE), a bugtracker built on distributed version
 5  control.  It works with Bazaar, Darcs, Git, Mercurial, and Monotone
 6  at the moment, but is easily extensible.  It can also function with no
 7  VCS at all.
 8  
 9  The idea is to package the bug information with the source code, so that
10  bugs can be marked "fixed" in the branches that fix them.  So, instead of
11  numbers, bugs have globally unique ids.
12  
13  
14  Getting BE
15  ==========
16  
17  BE is available as a Git repository::
18  
19      $ git clone https://gitlab.com/bugseverywhere/bugseverywhere.git be
20  
21  See the homepage_ for details.  If you do branch the Git repo, you'll
22  need to run::
23  
24      $ make
25  
26  to build some auto-generated files (e.g. ``libbe/_version.py``), and::
27  
28      $ make install
29  
30  to install BE.  By default BE will install into your home directory,
31  but you can tweak the ``INSTALL_OPTIONS`` variable in ``Makefile``
32  to install to another location.
33  
34  .. _homepage: http://bugseverywhere.org/
35  
36  
37  Getting started
38  ===============
39  
40  To get started, you must set the bugtracker root.  Typically, you will want to
41  set the bug root to your project root, so that Bugs Everywhere works in any
42  part of your project tree.::
43  
44      $ be init -r $PROJECT_ROOT
45  
46  To create bugs, use ``be new $DESCRIPTION``.  To comment on bugs, you
47  can can use ``be comment $BUG_ID``.  To close a bug, use
48  ``be close $BUG_ID`` or ``be status $BUG_ID fixed``.  For more
49  commands, see ``be help``.  You can also look at the usage examples in
50  ``test_usage.sh``.
51  
52  
53  Documentation
54  =============
55  
56  If ``be help`` isn't scratching your itch, the full documentation is
57  available in the doc directory as reStructuredText_ .  You can build
58  the full documentation with Sphinx_ , convert single files with
59  docutils_ , or browse through the doc directory by hand.
60  ``doc/index.txt`` is a good place to start.  If you do use Sphinx,
61  you'll need to install numpydoc_ for automatically generating API
62  documentation.  See the ``NumPy/SciPy documentation guide``_ for an
63  introduction to the syntax.
64  
65  .. _reStructuredText:
66    http://docutils.sourceforge.net/docs/user/rst/quickref.html
67  .. _Sphinx: http://sphinx.pocoo.org/
68  .. _docutils: http://docutils.sourceforge.net/
69  .. _numpydoc: http://pypi.python.org/pypi/numpydoc
70  .. _NumPy/SciPy documentation guide:
71    https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt