README

   1 Bugs Everywhere
   2 ===============
   3 This is Bugs Everywhere, a bugtracker built on distributed revision control.
   4 It works with Bazaar and Arch at the moment, but is easily extensible.  It
   5 can also function with no RCS at all.
   6
   7 The idea is to package the bug information with the source code, so that
   8 bugs can be marked 'fixed' in the branches that fix them.  So, instead of
   9 numbers, bugs have ids.
  10
  11 Getting started
  12 ===============
  13 To get started, you must set the bugtracker root.  Typically, you will want to
  14 set the bug root to your project root, so that Bugs Everywhere works in any
  15 part of your project tree.
  16 $ be set-root $PROJECT_ROOT
  17
  18 To create bugs, use "be new $DESCRIPTION".  To comment on bugs, you can can use
  19 "be comment $BUG_ID".  To close a bug, use "be close $BUG_ID".  For more
  20 commands, see "be help"
  21
  22 Using BeWeb, the web UI
  23 =======================
  24 BeWeb uses the Turbogears framework: http://www.turbogears.org/
  25 Please ensure you have Turbogears 0.8a5 or a compatible release installed.
  26 Because it uses BE data, the web UI does not require a database.
  27
  28 To use BeWeb, first create a configuration file, telling it which projects
  29 to track, and what to call them.  An example configuration file
  30 (beweb/beweb/config.py.example) is provided.
  31
  32 Next, cd to beweb, and run ./beweb-start.py
  33
  34 BeWeb allows you to create, view and edit bugs, but it is in an early stage of
  35 development, so some features are missing.