aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2015-06-12 03:36:57 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2015-06-12 03:36:57 +0300
commit144b8596db7b45e22448e63d115b9902c14259fd (patch)
treeb7b8b87821f82f13e2c34058ea7eef56a5cd0469 /README.md
parentadd error message formatting functions (diff)
downloadaes-tools-144b8596db7b45e22448e63d115b9902c14259fd.tar.gz
aes-tools-144b8596db7b45e22448e63d115b9902c14259fd.zip
add function docs to parts of the library
Diffstat (limited to '')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8a10fb6..18deb3f 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,11 @@ You can then run a program like this:
> sde -- aes128ecb_encrypt_block.exe 000102030405060708090a0b0c0d0e0f 00112233445566778899aabbccddeeff
69c4e0d86a7b0430d8cdb78070b4c55a
+## Documentation
+
+You can generate the docs using [Doxygen](http://www.stack.nl/~dimitri/doxygen/).
+The docs will be put into the `doc` directory in the repository's root.
+
## Testing
See [Testing](https://github.com/egor-tensin/aesni/tree/master/test#testing).