Updated README and Bugs-Everywhere-Web/README.
[be.git] / 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 "be close
22 $BUG_ID" or "be status $BUG_ID fixed".  For more commands, see "be
23 help".  You can also look at the usage examples in test_usage.sh.