summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJames Vasile <james@jamesvasile.com>2013-12-31 16:43:48 -0500
committerLars Wirzenius <liw@liw.fi>2014-06-03 16:33:22 +0100
commitddcd0e88f7d7f74884ee8719337bd2f895bd9059 (patch)
treeae280c2e4d3fa8ab1346c90fe4ef6c590c30d3b0 /README
parentecd0d09549c7ec5a8078cb0350312170eba37657 (diff)
downloadobnam-ddcd0e88f7d7f74884ee8719337bd2f895bd9059.tar.gz
Document how to run from the repo dir
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 7 insertions, 2 deletions
diff --git a/README b/README
index 9bf17518..bcf7dbdb 100644
--- a/README
+++ b/README
@@ -44,6 +44,11 @@ dependencies on a Debian system. (That set actually gets tested. The
above list is maintained manually and may get out of date from time
to time.)
+If you want to run obnam from the repository directory (rather than installing
+it), you need to do some setup. Run `./check --fast`. You'll need dev files
+for python and the Coverage Test Runner python module (on Debian, those are the
+python-dev and python-coverage-test-runner packages).
+
Use
---
@@ -81,8 +86,8 @@ To build and run automatic tests:
`check` is a wrapper around `python setup.py`, but since using that
takes several steps, the script makes things easier.
-You need my CoverageTestRunner to run tests, see above for where to get it.
-A couple of scripts exist to run benchmarks and profiles:
+You need my CoverageTestRunner to run tests, see above for where to get it. A
+couple of scripts exist to run benchmarks and profiles:
./metadata-speed 10000
./obnam-benchmark --size=1m/100k --results /tmp/benchmark-results