1 files changed, 60 insertions, 0 deletions
diff --git a/interfaces/web/Bugs-Everywhere-Web/README b/interfaces/web/Bugs-Everywhere-Web/README
new file mode 100644
index 0000000..c152757
--- /dev/null
+++ b/interfaces/web/Bugs-Everywhere-Web/README
@@ -0,0 +1,60 @@
+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 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
+it manages, so you should probably have it running on a seperate
+branch than your working repository.  You can then merge/push
+as you require to keep the branches in sync.
+
+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,
+but only registered 'editbugs' members can change things.
+
+Anonymous actions:
+ * See project tree
+ * See buglist
+ * See comments
+Editbugs required actions:
+ * Create new comments
+ * 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
+For a good intro.  For the impatient, try something like
+  Bugs-Everywhere-Web$ tg-admin toolbox
+  browse to 'CatWalk' -> 'User' -> 'Add User+'
+or
+  Bugs-Everywhere-Web$ tg-admin sholl
+  >>> u = User(user_name=u'jdoe', email_address=u'jdoe@example.com',
+      display_name=u'Jane Doe', password=u'xxx')
+  >>> g = Group(group_name=u'editbugs', display_name=u'Edit Bugs')
+  >>> g.addUser(u)           # BE-Web uses SQLObject
+Exit the tg-admin shell with Ctrl-Z on MS Windows, Ctrl-D on other systems.