aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorW. Trevor King <wking@drexel.edu>2009-11-19 00:39:31 -0500
committerW. Trevor King <wking@drexel.edu>2009-11-19 00:39:31 -0500
commit6e171ccd2ab07193b2f16350d00270229ec0c0a1 (patch)
tree293efaea173d1d6b9cbbe35e0bc43321bbfde0b5
parent5563818b85a7c9f68ede85cae902aceea42e5679 (diff)
downloadbugseverywhere-6e171ccd2ab07193b2f16350d00270229ec0c0a1.tar.gz
Updated README and Bugs-Everywhere-Web/README.
-rw-r--r--README18
-rw-r--r--interfaces/web/Bugs-Everywhere-Web/README (renamed from interfaces/web/Bugs-Everywhere-Web/README.txt)24
2 files changed, 22 insertions, 20 deletions
diff --git a/README b/README
index b43c15c..031ae13 100644
--- a/README
+++ b/README
@@ -15,25 +15,9 @@ 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 init $PROJECT_ROOT
+$ be init -r $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" or "be status $BUG_ID fixed". For more commands, see "be
help". You can also look at the usage examples in test_usage.sh.
-
-
-Using BeWeb, the web UI
-=======================
-BeWeb uses the Turbogears framework: http://www.turbogears.org/
-Please ensure you have Turbogears 0.8a5 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.
diff --git a/interfaces/web/Bugs-Everywhere-Web/README.txt b/interfaces/web/Bugs-Everywhere-Web/README
index 10774df..c152757 100644
--- a/interfaces/web/Bugs-Everywhere-Web/README.txt
+++ b/interfaces/web/Bugs-Everywhere-Web/README
@@ -1,7 +1,20 @@
-Bugs-Everywhere-Web
+Using BeWeb, the web UI
+=======================
+BeWeb uses the Turbogears framework: http://www.turbogears.org/
+Please ensure you have Turbogears 0.8a5 or a compatible release installed.
+Because it uses BE data, the web UI does not require a database.
-This is a TurboGears (http://www.turbogears.org) project. It can be
-started by running the start-beweb.py script.
+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 this directory, and run ./start-beweb.py
+
+BeWeb allows you to create, view and edit bugs, but it is in an early stage of
+development, so some features are missing.
+
+Configuration file
+------------------
Configure by creating an appropriate beweb/config.py from
beweb/config.py.example. The server will edit the repositories that
@@ -13,6 +26,9 @@ See
http://docs.turbogears.org/1.0/Configuration
For standard turbogears configuration information.
+Actions
+-------
+
Currently, you need to login for any methods with a
@identity.require() decorator. The only group in the current
implementation is 'editbugs'. Basically, anyone can browse around,
@@ -27,6 +43,8 @@ Editbugs required actions:
* Reply to comments
* Update comment info
+Users
+-----
All login attempts will fail unless you have added some valid users. See
http://docs.turbogears.org/1.0/GettingStartedWithIdentity