From d2752cde56e7cf67abc2e7f0a0fc91612016585f Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Wed, 27 Jan 2010 08:22:22 -0500
Subject: [PATCH] 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.
...
---
 Makefile       |  3 +++
 README         | 26 +++++++++++++++++++++++++-
 doc/README.dev |  3 +++
 3 files changed, 31 insertions(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index ad78ccb..568e42c 100644
--- 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 fe0fd08..b39fca1 100644
--- 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 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
 =========
-- 
2.26.2