Encourage a run of `make` to build auto-generated files.

Fixes Ben's "unintuitive test procedure" bug:

Date: Wed, 27 Jan 2010 14:09:14 +1100
From: Ben Finney
Subject: [Be-devel] Re: Test suite on Trevor's development branch
...
> $ python ./test.py
> Traceback (most recent call last):
[...]
> ImportError: No module named _version

So it's not possible to simply get a copy of the branch and try running
the test suite.
...

diff --git a/Makefile b/Makefile
index ad78ccb3fc4676f480bc9c610e570198b027421a..568e42c0e4db43b92b1d249c4d09dcb971752a9a 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -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 > $@

diff --git a/README b/README
index fe0fd08238fda1fd019304dc719946f633df303e..b39fca1fca2442977cba4b5bbab6fd6f62f0c285 100644 (file)
--- a/README
+++ b/README
@@ -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 cfb189663cdb44ce31f6585803a3db76fb364abf..67be177b9891e27a7089b65508919c263c54a983 100644 (file)
--- 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
 =========