diff options
| -rw-r--r-- | Makefile | 3 | ||||
| -rw-r--r-- | README | 26 | ||||
| -rw-r--r-- | doc/README.dev | 3 |
3 files changed, 31 insertions, 1 deletions
@@ -66,6 +66,9 @@ install: doc build clean: $(RM) -rf ${GENERATED_FILES} +test : build + python test.py + .PHONY: libbe/_version.py libbe/_version.py: bzr version-info --format python > $@ @@ -1,6 +1,7 @@ Bugs Everywhere =============== -This is Bugs Everywhere, a bugtracker built on distributed revision + +This is Bugs Everywhere (BE), a bugtracker built on distributed revision control. It works with Arch, Bazaar, Darcs, Git, and Mercurial at the moment, but is easily extensible. It can also function with no RCS at all. @@ -9,9 +10,32 @@ 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 +========== + +BE is available as a bzr repository:: + + $ bzr branch http://bzr.bugseverywhere.org/be + +See the homepage_ for details. If you do branch the bzr repo, you'll +need to run:: + + $ make + +to build some auto-generated files (e.g. ``libbe/_version.py``), and:: + + $ make install + +to install BE. By default BE will install into your home directory, +but you can tweak the ``PREFIX`` variable in ``Makefile`` to install +to another location. + +.. _homepage: http://bugseverywhere.org/ + 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. diff --git a/doc/README.dev b/doc/README.dev index cfb1896..67be177 100644 --- a/doc/README.dev +++ b/doc/README.dev @@ -52,6 +52,9 @@ for example: For a definition of "any tests", see ``test.py``'s ``add_module_tests()`` function. +Note that you will need to run ``make`` before testing a clean BE +branch to auto-generate required files like ``libbe/_version.py``. + Profiling ========= |