aboutsummaryrefslogtreecommitdiff
path: root/thirdparty/BLAKE3/reference_impl/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'thirdparty/BLAKE3/reference_impl/README.md')
-rw-r--r--thirdparty/BLAKE3/reference_impl/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/thirdparty/BLAKE3/reference_impl/README.md b/thirdparty/BLAKE3/reference_impl/README.md
new file mode 100644
index 000000000..941fafd72
--- /dev/null
+++ b/thirdparty/BLAKE3/reference_impl/README.md
@@ -0,0 +1,9 @@
+This is the reference implementation of BLAKE3. It is used for testing and
+as a readable example of the algorithms involved. Section 5.1 of [the BLAKE3
+spec](https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf)
+discusses this implementation. You can render docs for this implementation
+by running `cargo doc --open` in this directory.
+
+This implementation is a single file
+([`reference_impl.rs`](reference_impl.rs)) with no dependencies. It is
+not optimized for performance.