]> git.codecow.com Git - Monocypher.git/commitdiff
updated README.md
authorLoup Vaillant <loup@loup-vaillant.fr>
Thu, 6 Jul 2017 20:05:32 +0000 (22:05 +0200)
committerLoup Vaillant <loup@loup-vaillant.fr>
Thu, 6 Jul 2017 20:05:32 +0000 (22:05 +0200)
README.md

index bfc460ab7397ef7f91f036074e808e46f8ca035c..cbfb7f6e36a4d96b7b7ae1a203e091276ef5cdda 100644 (file)
--- a/README.md
+++ b/README.md
@@ -21,7 +21,8 @@ before you run them.
 To run only the self contained tests, run
 
     $ make test
-    $ ./test
+    $ ./vectors
+    $ ./properties
 
 To run only the edDSA fuzz tests (compares Monocypher with
 ed25519-donna), run
@@ -41,6 +42,18 @@ This will have frama-c parse, and analyse the code, then launch a GUI.
 You must have frama-c installed.  See frama-c.sh for the recommended
 settings.
 
+Speed benchmark
+---------------
+
+    $ make speed
+    $ ./speed
+
+It should tell you how well Monocypher fares against libsodium.
+Results may vary between platforms and libsodium implementations.
+Requires the POSIX `clock_gettime()` function, which is generally
+disabled when using -std=C99 for strict C compliance. (See the
+makefile to modify it.)
+
 Integration to your project
 ---------------------------