From 7410bc1b543ee15e9b3677ab2b597bb0c10c775a Mon Sep 17 00:00:00 2001 From: Leonetienne Date: Wed, 1 Jun 2022 20:58:31 +0200 Subject: [PATCH] Add docs link to readme --- readme.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/readme.md b/readme.md index 46b7a56..d3828a7 100644 --- a/readme.md +++ b/readme.md @@ -2,6 +2,9 @@ *(GhettoCrypt), because frankly I have no idea what the fuck I'm doing* *Please don't use this for anything critical* +## [Documentation](https://gcrypt.rtfm.leonetienne.de/) + + ## What the hell is this? An educational project on implementing a block cipher using a feistel network. This block cipher employs a few modes of operation. Read more about them [here](#modes-of-operation). @@ -102,6 +105,8 @@ This way you can cipher on bitlevel. Examples on how to do this are in [GWrapper This way you could, for example, decrypt an ecrypted file directly into memory. Without saying, this is more advanced and not as-easy as the methods supplied in the wrapper. +Want more documentation? See the [doxygen page](https://gcrypt.rtfm.leonetienne.de/). + --- ## The deets 🍝