aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKyle Altendorf <sda@fstab.net>2019-09-10 08:43:15 -0400
committerKyle Altendorf <sda@fstab.net>2019-09-10 08:43:23 -0400
commite802f9cc563abdb6f3ee4c4137edc6f293fdd8d2 (patch)
tree341fa5f8d011756778a1932c0325b958ada0041f /README.md
parentMerge pull request #13 from altendky/use_UINTxx_C_macros (diff)
downloadsiphash-e802f9cc563abdb6f3ee4c4137edc6f293fdd8d2.tar.gz
siphash-e802f9cc563abdb6f3ee4c4137edc6f293fdd8d2.tar.xz
Make *c* and *d* rounds less intrusively configurable
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/README.md b/README.md
index 7af7657..1b4157b 100644
--- a/README.md
+++ b/README.md
@@ -42,13 +42,20 @@ verifies 64 test vectors, and
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
-lines
-```C
-#define cROUNDS 2
-#define dROUNDS 4
+with *c* compression rounds and *d* finalization rounds, by defining `cROUNDS`
+or `dROUNDS` when compiling. This can be done with `-D` command line arguments
+to many compilers such as below.
+
+```sh
+gcc -Wall --std=c99 -DcROUNDS=2 -DdROUNDS=4 siphash.c halfsiphash.c test.c -o test
```
+The `makefile` also takes *c* and *d* rounds values as parameters.
+
+```sh
+make cROUNDS=2 dROUNDS=4
+```
+
Obviously, if the number of rounds is modified then the test vectors
won't verify.