summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2023-10-15 01:06:41 -0400
committerPaul Duncan <pabs@pablotron.org>2023-10-15 01:06:41 -0400
commit76e242ce7640f6f1a79e9af95330afa56f2a46df (patch)
tree261db59c135d7bea04a2345264938f319dabb6a2
parentbe1f3af3423b38100faf8afe1388fd78ea0df58b (diff)
downloadsha3-76e242ce7640f6f1a79e9af95330afa56f2a46df.tar.bz2
sha3-76e242ce7640f6f1a79e9af95330afa56f2a46df.zip
README.md: add "Tests" section
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index e19904d..3cbc785 100644
--- a/README.md
+++ b/README.md
@@ -174,6 +174,15 @@ Full [API][] documentation is available in the comments of `sha3.h`. If
you have [Doxygen][] installed, you can generate [HTML][]-formatted
[API][] documentation by typing `make doc`.
+## Tests
+
+Use `make test` to build and run the test suite.
+
+The test suite checks each component of this implementation for expected
+answers and is built with several sanitizers supported by both [GCC][]
+and [Clang][]. The source code for the test suite is embedded at the
+bottom of `fips203ipd.c` behind a `TEST_FIPS203IPD` define.
+
## References
* [FIPS 202 - SHA-3 Standard: Permutation-Based Hash and Extendable-Output Functions][FIPS 202]
@@ -223,3 +232,7 @@ you have [Doxygen][] installed, you can generate [HTML][]-formatted
"Application Programming Interface (API)"
[html]: https://en.wikipedia.org/wiki/HTML
"HyperText Markup Language (HTML)"
+[gcc]: https://en.wikipedia.org/wiki/GNU_Compiler_Collection
+ "GNU Compiler Collection."
+[clang]: https://en.wikipedia.org/wiki/Clang
+ "LLVM compiler front end."