summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2010-12-29 20:48:16 +0000
committerLars Wirzenius <liw@liw.fi>2010-12-29 20:48:16 +0000
commitac106db2a94052b572798b0143aff842491d2fb8 (patch)
tree73fc1406adb3f957cf217be6c82d65991a9a8ff3 /README
parent1954248e1633036afa72bee39a83c45fb4d60a28 (diff)
downloadobnam-ac106db2a94052b572798b0143aff842491d2fb8.tar.gz
Update README with some new info and improved markup.
Diffstat (limited to 'README')
-rw-r--r--README23
1 files changed, 12 insertions, 11 deletions
diff --git a/README b/README
index 55bcf8c4..0ad7845f 100644
--- a/README
+++ b/README
@@ -16,6 +16,10 @@ Home page
The Obnam home page is at <http://braawi.org/obnam/>, see there
for more information.
+More usefully, perhaps, the on-disk data structure description
+(i.e., how obnam uses copy-on-write B-trees), is at
+<http://braawi.org/obnam/ondisk/>.
+
Installation
------------
@@ -26,12 +30,14 @@ 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, ttystatus, and LRU libraries, which you
+You need to install my B-tree, and some other libraries and tools, which you
can get from:
- http://liw.fi/btree/
- http://liw.fi/ttystatus/
- http://liw.fi/python-lru/
+* <http://liw.fi/btree/>
+* <http://liw.fi/ttystatus/>
+* <http://liw.fi/python-lru/>
+* <http://liw.fi/coverage-test-runner/>
+* <http://liw.fi/extrautils/>
Use
@@ -69,19 +75,14 @@ To run automatic tests:
make check
python test-sftpfs # Read it first, though. Requires ssh setup.
-You need my CoverageTestRunner to run tests, get it from:
-
- http://liw.fi/coverage-test-runner/
-
+You need my CoverageTestRunner to run tests, see above for where to get it.
A couple of scripts exist to run benchmarks and profiles:
./run-benchmark
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:
-
- http://liw.fi/extrautils/
+You can use your own, or get mine from extrautils (see above).
If you make any changes, I welcome patches, either as plain diffs, bzr
bundles, or public repositories I can merge from.