Update README.md to include release URL (#131)

Make it clear the user has got a git version that does not include
the configure script. Also has the advantage of publishing the location
when browsing the repository.

Remove the as part of the build, so that someone who gets a source
package with ./configure already does not get confused.

diff --git a/Makefile.am b/Makefile.am
index 72f0502cd5e097551717c5bb8dc4a9ffb3f77b30..6dcdfc1d1983682d64675f05233483b6da12921a 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -19,7 +19,7 @@ MAINTAINERCLEANFILES= \
 EXTRA_DIST = \
        .gitignore \
        autogen.sh \
-       README.md \
+       README \
        LICENSE.md \
        autogen.sh \
        netdata-9999.ebuild \
@@ -37,6 +37,15 @@ SUBDIRS = \
        web \
        $(NULL)
 
+if GIT_TREE
+
+all-local: README
+
+README: README.md
+       sed -e '/^## Features$$/p' -e '/^## Git/,/^## Features$$/d' $< > $@
+
+endif
+
 dist_noinst_DATA = netdata.spec
 
 # until integrated within build

diff --git a/README.md b/README.md
index 6f479e2294c38cd7debbad307540d60e20fef042..6eb79caaf2f4c902bca5745be9683653fb07c029 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -6,6 +6,15 @@
 
 ---
 
+## Git sources
+
+You are looking at a version of the sources extracted directly from git.
+If you want a version of the source package where `configure` and any
+documentation has been built for you, please get an official
+[netdata package download](https://firehol.org/download/netdata/).
+The `unsigned/master` folder tracks the head of the git tree and
+released packages are also available.
+
 ## Features
 
 **netdata** is a highly optimized Linux daemon providing **real-time performance monitoring for Linux systems, Applications, SNMP devices, over the web**!

diff --git a/configure.ac b/configure.ac
index 5bdb01401ea91e8b20fd7d1bdf9fbb52dde6b594..8d6f441e8780c8fef512aef3486177e05a7399f3 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -14,6 +14,8 @@ PACKAGE_RPM_RELEASE="0.0.$(echo VERSION_SUFFIX | sed 's/^_//')"
 
 AC_INIT([netdata], VERSION_NUMBER[]VERSION_SUFFIX)
 
+AM_CONDITIONAL([GIT_TREE], [test -f README.md])
+
 AM_MAINTAINER_MODE([disable])
 if test x"$USE_MAINTAINER_MODE" = xyes; then
 AC_MSG_NOTICE(***************** MAINTAINER MODE *****************)