README

   1 Bugs Everywhere
   2 ===============
   3 This is Bugs Everywhere, a bugtracker built on distributed revision
   4 control.  It works with Arch, Bazaar, Darcs, Git, and Mercurial at the
   5 moment, but is easily extensible.  It can also function with no RCS at
   6 all.
   7
   8 The idea is to package the bug information with the source code, so that
   9 bugs can be marked "fixed" in the branches that fix them.  So, instead of
  10 numbers, bugs have globally unique ids.
  11
  12
  13 Getting started
  14 ===============
  15 To get started, you must set the bugtracker root.  Typically, you will want to
  16 set the bug root to your project root, so that Bugs Everywhere works in any
  17 part of your project tree.
  18 $ be init -r $PROJECT_ROOT
  19
  20 To create bugs, use ``be new $DESCRIPTION``.  To comment on bugs, you
  21 can can use ``be comment $BUG_ID``.  To close a bug, use
  22 ``be close $BUG_ID`` or ``be status $BUG_ID fixed``.  For more
  23 commands, see ``be help``.  You can also look at the usage examples in
  24 ``test_usage.sh``.
  25
  26 Documentation
  27 =============
  28
  29 If ``be help`` isn't scratching your itch, there's also
  30
  31 * doc/tutorial        (a gentle introduction to BE)
  32 * doc/distributed_bugtracking  (notes on distributed workflows)
  33 * doc/spam            (notes on removing spam entries from VCSs)
  34 * doc/README.dev      (a guide to hacking BE)
  35
  36 The documentation is marked up in reStructuredText_, so you can use
  37 the docutils_ to convert it to other formats if you desire.
  38
  39 .. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html
  40 .. _docutils: http://docutils.sourceforge.net/