README: Add basic build instructions.

Signed-off-by: Mark Wielaard <mark@klomp.org>

diff --git a/ChangeLog b/ChangeLog
index 86b19b53fdf65875633f4310280bb4711420fa9f..c0034ba481f4c18c52f7d2031a52a85dae060746 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2017-09-19  Mark Wielaard  <mark@klomp.org>
+
+       * README: Add basic build instructions.
+
 2017-05-03  Ulf Hermann  <ulf.hermann@qt.io>
 
        * configure.ac: Test if symbol versioning is supported.

diff --git a/README b/README
index 9e55d75a50ff0c3bef0b82b448f1f8bef63f9d6f..0e15bae6bb69564de0a6764db738f31d36bc1144 100644 (file)
--- a/README
+++ b/README
@@ -5,11 +5,20 @@ The project home is http://elfutils.org/
 Releases are published at ftp://sourceware.org/pub/elfutils/
 Which can also be found at https://sourceware.org/elfutils/ftp/
 
+To build a release do: ./configure && make && make check
+Please check the configure summary to make sure all recommended
+features are enabled. There should be no failures after make check.
+
 Please reports bugs at https://sourceware.org/bugzilla/
 
 The current elfutils source code can be checked out with
 git clone git://sourceware.org/git/elfutils.git
 
+To build a git checkout do:
+  autoreconf -i -f && \
+  ./configure --enable-maintainer-mode && \
+  make && make check
+
 The developer mailinglist to send patches to is
 elfutils-devel@sourceware.org.
 https://sourceware.org/ml/elfutils-devel/