diff options
author | norly <ny-git@enpas.org> | 2013-06-28 16:28:51 +0100 |
---|---|---|
committer | norly <ny-git@enpas.org> | 2015-02-24 00:18:27 +0100 |
commit | d0eb1cc5d50fd7355028d338f71a98609a0c1520 (patch) | |
tree | 36d6d63d419100364482ab5246a53ae1c93ac5a3 /docs | |
parent | 5a0dc4a9f9070827686680b59bb4e0611da7930c (diff) |
More READMEs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/building.md | 60 | ||||
-rw-r--r-- | docs/credits.txt | 6 |
2 files changed, 66 insertions, 0 deletions
diff --git a/docs/building.md b/docs/building.md new file mode 100644 index 0000000..60282fa --- /dev/null +++ b/docs/building.md @@ -0,0 +1,60 @@ +Build instructions +================== + +To build the CLI front-end, the static library and the shared library, +change to the top-level directory and run + + make + +This will create a build/ directory containing the intermediary and +output files. + + +Dependencies and pkg-config +--------------------------- + +There is currently one hard dependency, libelf. + +The Makefile uses pkg-config to try and autodetect the necessary +compiler and linker flags. Failing this, it defaults to "-lelf" to +link against libelf, and no additional include directories. + +On Ubuntu, development files can be installed using + apt-get install libelfg0-dev +for tired's libelf (preferred), or + apt-get install libelf-dev +for Red Hat's libelf. + + +Documentation +------------- + +Additional documentation can be generated from the source files using +Doxygen. If it is available on your machine, issue + + make docs + +to build it in docs/. + + +Cleanup +------- + +The usual + make clean +and + make distclean +are supported to clean binary files (clean), or all backup and +generated files (distclean). + + +Installation +------------ + +There is currently no automated installation. + +If you need system-wide availability, you can copy + include/libelfu --> /usr/local/include/ + build/elfucli --> /usr/local/bin/ + build/libelfu.{a,so*} --> /usr/local/lib/ +or your local variation thereof. diff --git a/docs/credits.txt b/docs/credits.txt new file mode 100644 index 0000000..a18f966 --- /dev/null +++ b/docs/credits.txt @@ -0,0 +1,6 @@ +centaur is Copyright 2013, Max Staudt. + +It builds upon libelf, of which there are various implementations. +Testing has been done with tired's libelf, as well as Red Hat's variant. + +See http://www.mr511.de/software/english.html for more details on libelf. |