diff options
author | Aaron Bentley <aaron.bentley@utoronto.ca> | 2005-12-03 18:35:35 -0500 |
---|---|---|
committer | Aaron Bentley <aaron.bentley@utoronto.ca> | 2005-12-03 18:35:35 -0500 |
commit | 73097df356637372f5a18cadb9ac37d597aa2d24 (patch) | |
tree | 11951dabe44af8bd3564f046a616d7fc451b628f | |
parent | c51060864bdc774b6ad118f6319ad7c0c4a4815a (diff) | |
download | bugseverywhere-73097df356637372f5a18cadb9ac37d597aa2d24.tar.gz |
Updated docs
-rw-r--r-- | .bzrignore | 1 | ||||
-rw-r--r-- | AUTHORS | 3 | ||||
-rw-r--r-- | NEWS | 2 | ||||
-rw-r--r-- | README | 35 |
4 files changed, 41 insertions, 0 deletions
diff --git a/.bzrignore b/.bzrignore new file mode 100644 index 0000000..1a6afa0 --- /dev/null +++ b/.bzrignore @@ -0,0 +1 @@ +beweb/beweb/config.py @@ -0,0 +1,3 @@ +Bugs Everywhere was written by: +Aaron Bentley +Oleg Romanyshyn @@ -0,0 +1,2 @@ +December 3, 2005 +* Added new "webbe" web interface @@ -0,0 +1,35 @@ +Bugs Everywhere +=============== +This is Bugs Everywhere, a bugtracker built on distributed revision control. +It works with Bazaar-NG and Arch at the moment, but is easily extensible. It +can also function with no RCS at all. + +The idea is to package the bug information with the source code, so that +bugs can be marked 'fixed' in the branches that fix them. So, instead of +numbers, bugs have ids. + +Getting started +=============== +To get started, you must set the bugtracker root. Typically, you will want to +set the bug root to your project root, so that Bugs Everywhere works in any +part of your project tree. +$ be set-root $PROJECT_ROOT + +To create bugs, use "be new $DESCRIPTION". To comment on bugs, you can can use +"be comment $BUG_ID". To close a bug, use "be close $BUG_ID". For more +commands, see "be help" + +Using BeWeb, the web UI +======================= +BeWeb uses the Turbogears framework: http://www.turbogears.org/ +Please ensure you have Turbogears 0.8a4 or a compatible release installed. +Because it uses BE data, the web UI does not require a database. + +To use BeWeb, first create a configuration file, telling it which projects +to track, and what to call them. An example configuration file +(beweb/beweb/config.py.example) is provided. + +Next, cd to beweb, and run ./beweb-start.py + +BeWeb allows you to create, view and edit bugs, but it is in an early stage of +development, so some features are missing. |