bench: add note to README.rst about how to run the benchmarks, update the "not really...

[tahoe-lafs/zfec.git] / zfec / README.rst

diff --git a/zfec/README.rst b/zfec/README.rst
index e09d8f3449b64b9a6c87fda1036d50a9cf4d4787..0ee8ede4b60048de7a5dc0b01af5f8e7a37a66c8 100644 (file)
--- a/zfec/README.rst
+++ b/zfec/README.rst
@@ -146,6 +146,9 @@ proof-of-retrievability, and repair of damaged files and directories.
 Performance
 -----------
 
+To run the benchmarks, execute the included bench/bench_zfec.py script
+with optional --k= and --m= arguments.
+
 On my Athlon 64 2.4 GHz workstation (running Linux), the "zfec" command-line
 tool encoded a 160 MB file with m=100, k=94 (about 6% redundancy) in 3.9
 seconds, where the "par2" tool encoded the file with about 6% redundancy in 27