From: Loup Vaillant Date: Tue, 30 Jan 2018 20:42:49 +0000 (+0100) Subject: Increase documentation accessibility from the GitHub repository X-Git-Url: https://git.codecow.com/?a=commitdiff_plain;h=90fe7830683d16cc69dd4e44afda74e9fc751dcc;p=Monocypher.git Increase documentation accessibility from the GitHub repository Fixes #83 Help the poor user by linking the hell out of https://monocypher.org/. Users are supposed to use the official releases, not the repository. Generated files in the repository are ugly. They would displease the Dictator. So, nope. --- diff --git a/README.md b/README.md index 7a5d8e8..4cbf940 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ inspired by [libsodium][] and [TweetNaCl][], written in portable C. It means to eat Libsodium's lunch. -[Official site.](https://monocypher.org/) +[Official site.](https://monocypher.org/) +[Official releases.](http://monocypher.org/download/) [libsodium]: http://libsodium.org [TweetNaCl]: http://tweetnacl.cr.yp.to/ @@ -14,11 +15,15 @@ It means to eat Libsodium's lunch. Manual ------ +The manual can be found at https://monocypher.org/manual/, and in the +`doc/` folder. + The `doc/man/` folder contains the man pages. You can install them in your system by running `make install-doc`. -There is a html version in `doc/html/`, that you can regenerate by -executing the `doc/man2html.sh` script (this requires mandoc). +Unless you cloned the git repository, there is a html version in +`doc/html/`, that you can regenerate by executing the `doc/man2html.sh` +script. This requires mandoc. Installation