aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJP Aumasson <jeanphilippe.aumasson@gmail.com>2014-03-23 14:01:33 +0100
committerJP Aumasson <jeanphilippe.aumasson@gmail.com>2014-03-23 14:01:33 +0100
commit2d4d778ffd14419c80fbb5626c24eafc789ff2f1 (patch)
treef858c2d483cc1e8db33db4e4ec2f4af3216d6003 /README.md
parentmake dist (diff)
downloadsiphash-2d4d778ffd14419c80fbb5626c24eafc789ff2f1.tar.gz
siphash-2d4d778ffd14419c80fbb5626c24eafc789ff2f1.tar.xz
usage instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 482d0a3..6912c80 100644
--- a/README.md
+++ b/README.md
@@ -22,8 +22,20 @@ Running
$ make
```
-will compile and run sanity checks (test vectors) for SipHash-2-4, the
-default version of SipHash.
+will build sanity checks (test vectors) for SipHash-2-4, the default
+version of SipHash:
+
+```C
+ ./siphash24_test
+```
+
+verifies 64 test vectors, and
+
+```C
+ ./siphash24_test_debug
+```
+
+does the same and prints intermediate values.
The code can be adapted to implement SipHash-*c*-*d*, the version of SipHash
with *c* compression rounds and *d* finalization rounds, by tweaking the