From 3d46e181381c168b5d7e7e2704efa33581d296fb Mon Sep 17 00:00:00 2001 From: Loup Vaillant Date: Sat, 8 Feb 2020 18:23:51 +0100 Subject: [PATCH] Added warning in the Git version of the README I noticed that some careless hurried people tend to use Monocypher from the git repository directly. They don't even grab the releases from GitHub. That's not ideal for two reasons: 1. The master branch isn't always stable. 2. The Git repository misses some automatically generated files. This patch attempts to get end users away from the Git repository, towards well tested official releases. Also, for users who think the tarball are binary releases (they're source releases), or just want to be done as quickly as possible, I also gave direct links to the main source and header files. --- README.md | 15 +++++++++++++-- dist.sh | 8 +++++++- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5e39f34..a042d36 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ -Monocypher ----------- +Monocypher (Developer Edition) +------------------------------ + +_(This is the bleeding edge, not yet released version. If you just want +to use Monocypher, grab the [latest version][latest], or download the +[source][] and [header][] files directly. If you want to contribute, see +the notes at the end.)_ + +[source]: https://monocypher.org/download/monocypher.c +[header]: https://monocypher.org/download/monocypher.h +[latest]: https://monocypher.org/download/monocypher-latest.tar.gz + +--- Monocypher is an easy to use, easy to deploy, auditable crypto library written in portable C. It approaches the size of [TweetNaCl][] and the diff --git a/dist.sh b/dist.sh index e0f8903..52d9856 100755 --- a/dist.sh +++ b/dist.sh @@ -80,7 +80,13 @@ find $FOLDER -type f -exec sed -i "s/__git__/$VERSION/g" \{\} \; sed -i '/tests\/vectors.h:/,$d' $FOLDER/makefile # Remove contributor notes from the README -sed -i '/Contributor notes/,$d' $FOLDER/README.md +sed -e '/Contributor notes/,$d' \ + -e '1,/^---$/d' \ + -i $FOLDER/README.md +sed -e '1i\ +Monocypher\ +----------' \ + -i $FOLDER/README.md # Make the actual tarball tar -cvzf $TARBALL $FOLDER -- 2.47.3