From: norly <ny-git@enpas.org>
Date: Mon, 8 Jul 2013 15:48:02 +0000 (+0100)
Subject: README.md: Build instructions
X-Git-Url: https://git.enpas.org/?p=centaur.git;a=commitdiff_plain;h=7a5181bdc0e94d5d7ba0eeceb23d5406a105a5bd

README.md: Build instructions
---

diff --git a/README.md b/README.md
index 6d6dde3..c9ddb65 100644
--- a/README.md
+++ b/README.md
@@ -29,10 +29,29 @@ This functionality is exposed by the underlying `libelfu` via a C API,
 at the same high level. `elfucli` serves as an example application for
 it and doubles as a handy scalpel for ELF files.
 
-More examples can be found in the testsuite.
+More examples can be found in the testsuite. The 'detour' test is
+particularly similar to the example above.
 
 
-Build instructions, Credits, License, ...
------------------------------------------
+Build instructions, testing
+---------------------------
+
+Usually, a plain
+
+    make
+
+should be enough to build centaur, provided that a version of libelf
+and its development files are installed. If not, see docs/building.md
+for further hints such as the packages to be installed on Ubuntu.
+
+Once that is done,
+
+    make check
+
+will build and run the testsuite. See docs/tests.md for details.
+
+
+License, etc
+------------
 
 See the docs/ directory for all other documentation.