README

   1 Bugs Everywhere
   2 ===============
   3
   4 This is Bugs Everywhere (BE), a bugtracker built on distributed revision
   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 RCS at
   7 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 Getting BE
  14 ==========
  15
  16 BE is available as a bzr repository::
  17
  18     $ bzr branch http://bzr.bugseverywhere.org/be
  19
  20 See the homepage_ for details.  If you do branch the bzr repo, you'll
  21 need to run::
  22
  23     $ make
  24
  25 to build some auto-generated files (e.g. ``libbe/_version.py``), and::
  26
  27     $ make install
  28
  29 to install BE.  By default BE will install into your home directory,
  30 but you can tweak the ``PREFIX`` variable in ``Makefile`` to install
  31 to another location.
  32
  33 .. _homepage: http://bugseverywhere.org/
  34
  35
  36 Getting started
  37 ===============
  38
  39 To get started, you must set the bugtracker root.  Typically, you will want to
  40 set the bug root to your project root, so that Bugs Everywhere works in any
  41 part of your project tree.
  42 $ be init -r $PROJECT_ROOT
  43
  44 To create bugs, use ``be new $DESCRIPTION``.  To comment on bugs, you
  45 can can use ``be comment $BUG_ID``.  To close a bug, use
  46 ``be close $BUG_ID`` or ``be status $BUG_ID fixed``.  For more
  47 commands, see ``be help``.  You can also look at the usage examples in
  48 ``test_usage.sh``.
  49
  50 Documentation
  51 =============
  52
  53 If ``be help`` isn't scratching your itch, there's also
  54
  55 * doc/tutorial        (a gentle introduction to BE)
  56 * doc/distributed_bugtracking  (notes on distributed workflows)
  57 * doc/spam            (notes on removing spam entries from VCSs)
  58 * doc/README.dev      (a guide to hacking BE)
  59
  60 The documentation is marked up in reStructuredText_, so you can use
  61 the docutils_ to convert it to other formats if you desire.
  62
  63 .. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html
  64 .. _docutils: http://docutils.sourceforge.net/