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.

diff --git a/README.md b/README.md
index 5e39f342b05b5d68625cc4fd98c60754c0821191..a042d36b4c712568354634da85cdb732df2b6204 100644 (file)
--- 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 e0f89034912c83967bd1ff652d992a87e00eda88..52d98566f097f48be9c316414bee969b91fbf090 100755 (executable)
--- 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