summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2010-07-11 18:53:56 +1200
committerLars Wirzenius <liw@liw.fi>2010-07-11 18:53:56 +1200
commit192a800d58d2677091cf2b5316ed87f237f41acd (patch)
tree1b8c2752cb03224ebf9d6c68bd42bcd30ab09eb3 /README
parentc91da8921e8fa1c4edab4ec019c609ade7e019a8 (diff)
downloadobnam-192a800d58d2677091cf2b5316ed87f237f41acd.tar.gz
Update README to reflect current state of the world.
Diffstat (limited to 'README')
-rw-r--r--README26
1 files changed, 18 insertions, 8 deletions
diff --git a/README b/README
index 2d6857b7..a4bf0b3e 100644
--- a/README
+++ b/README
@@ -19,9 +19,11 @@ build an installation package.
On other systems, using the setup.py file might work: run
"python setup.py --help" for advice. If not, please tell me how to fix it.
-You need to install my B-tree and LRU libraries, which you can get from:
+You need to install my B-tree, ttystatus, and LRU libraries, which you
+can get from:
http://liw.fi/btree/
+ http://liw.fi/ttystatus/
http://liw.fi/python-lru/
@@ -44,6 +46,13 @@ For more information, see the manual page:
Hacking
-------
+The canonical version control repository for obnam itself is at:
+
+ http://code.liw.fi/obnam/bzr/
+
+The 'trunk' branch is the main development one. Note that the URL points
+at a bzr repository, it is not useful to browse it by hand.
+
To build:
make
@@ -60,14 +69,12 @@ You need my CoverageTestRunner to run tests, get it from:
A couple of scripts exist to run benchmarks and profiles:
./run-benchmark
- ./run-profile
- ./viewprof obnam.prof cumulative | less -S
-
-The canonical version control repository for obnam itself is at:
-
- http://code.liw.fi/obnam/bzr/
+ viewprof obnam.prof cumulative | less -S
+
+viewprof is a little helper script I wrote, around the Python pstats module.
+You can use your own, or get mine from:
-The rewrite4 branch is currently the main one.
+ http://liw.fi/extrautils/
If you make any changes, I welcome patches, either as plain diffs, bzr
bundles, or public repositories I can merge from.
@@ -93,6 +100,9 @@ Feedback
I welcome bug fixes, enhancements, bug reports, suggestions, requests,
and other feedback. I prefer e-mail (mailto:liw@liw.fi).
+It would be helpful if you can run "make clean check" before submitting
+a patch, but it is not strictly required.
+
Legal stuff
-----------