diff options
author | W. Trevor King <wking@drexel.edu> | 2010-02-06 09:47:20 -0500 |
---|---|---|
committer | W. Trevor King <wking@drexel.edu> | 2010-02-06 09:47:20 -0500 |
commit | da8309e67c669b1cca5d39c8e7da34c9b431bef6 (patch) | |
tree | 2d456f289307370f6cb27dfcbf0bbf759036e75f /README | |
parent | 4109434843ecdf2e73a010fcbb37cc3d404ef8ef (diff) | |
download | bugseverywhere-da8309e67c669b1cca5d39c8e7da34c9b431bef6.tar.gz |
Added page titles to the documentation & adjusted section levels.
Diffstat (limited to 'README')
-rw-r--r-- | README | 22 |
1 files changed, 11 insertions, 11 deletions
@@ -10,6 +10,7 @@ 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 globally unique ids. + Getting BE ========== @@ -38,8 +39,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 -r $PROJECT_ROOT +part of your project tree.:: + + $ 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 @@ -47,18 +49,16 @@ can can use ``be comment $BUG_ID``. To close a bug, use commands, see ``be help``. You can also look at the usage examples in ``test_usage.sh``. + Documentation ============= -If ``be help`` isn't scratching your itch, there's also - -* doc/tutorial (a gentle introduction to BE) -* doc/distributed_bugtracking (notes on distributed workflows) -* doc/spam (notes on removing spam entries from VCSs) -* doc/README.dev (a guide to hacking BE) - -The documentation is marked up in reStructuredText_, so you can use -the docutils_ to convert it to other formats if you desire. +If ``be help`` isn't scratching your itch, the full documentation is +available in the doc directory as reStructuredText_ . You can build +the full documentation with Sphinx_ , convert single files with +docutils_ , or browse through the doc directory by hand. +doc/index.txt is a good place to start. .. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html +.. _Sphinx: http://sphinx.pocoo.org/ .. _docutils: http://docutils.sourceforge.net/ |