From 07e6fd821ee44b137df036aa9e2ef2e13a845fee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9ophile=20Bastian?= Date: Tue, 28 May 2019 21:16:40 +0200 Subject: [PATCH] README: dependencies instructions --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b0a51cd..c0bddc8 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,22 @@ examine its assembly code and, based solely on that, generate the corresponding ## Dependencies -This tool relies on [BAP](https://github.com/BinaryAnalysisPlatform/bap), which -is available through OPAM. +This tool relies on + +* [BAP](https://github.com/BinaryAnalysisPlatform/bap) version 1.6 as of today, + which is available through OPAM; +* `objcopy`, often packaged as `binutils` +* `libelf` +* `libdwarf` +* `libdwarfw`, packaged as submodule + +### Installing dependencies + +You should be able to easily install `objcopy` (`binutils`), `libelf`, +`libdwarf` and `opam` via your package manager. Once +[`opam` is set up](https://opam.ocaml.org/doc/Install.html), you should be able +to simply `opam install bap`. We recommand that you use a fresh `opam switch` +in case you already have installed packages with `opam`. ## Compiling