From 7a5181bdc0e94d5d7ba0eeceb23d5406a105a5bd Mon Sep 17 00:00:00 2001 From: norly Date: Mon, 8 Jul 2013 16:48:02 +0100 Subject: [PATCH] README.md: Build instructions --- README.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) 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. -- 2.30.2