4 This is Bugs Everywhere (BE), a bugtracker built on distributed version
5 control. It works with Arch, Bazaar, Darcs, Git, and Mercurial at the
6 moment, but is easily extensible. It can also function with no VCS at
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.
17 BE is available as a bzr repository::
19 $ bzr branch http://bzr.bugseverywhere.org/be
21 See the homepage_ for details. If you do branch the bzr repo, you'll
26 to build some auto-generated files (e.g. ``libbe/_version.py``), and::
30 to install BE. By default BE will install into your home directory,
31 but you can tweak the ``PREFIX`` variable in ``Makefile`` to install
34 .. _homepage: http://bugseverywhere.org/
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.::
44 $ be init -r $PROJECT_ROOT
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
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.
62 .. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html
63 .. _Sphinx: http://sphinx.pocoo.org/
64 .. _docutils: http://docutils.sourceforge.net/