diff --git a/README.md b/README.md index f0eb35e27070018ffdf682083fc6e39c27010ea1..85c502f82c3be5323288022c5f0d817ada1e8925 100644 --- a/README.md +++ b/README.md @@ -17,44 +17,42 @@ Libraries (development version): * libxml2 * libxslt -For example, on Ubuntu/Debian, all the dependencies can be installed by -typing: +For example, on Ubuntu/Debian, all the dependencies can be installed by: sudo apt install build-essential python2 git cmake flex bison libxml2-dev libxslt-dev ocaml gcc-arm-none-eabi ## Installing OTAWA v2 ## -Then, you can download and install OTAWA v2, from here: - - http://www.otawa.fr/ - -To downaload and install OTAWA, you first download the script +To download and install OTAWA v2, first download the following script +and execute it using python 2.7: http://www.tracesgroup.net/otawa/packages/otawa-install.py -then execute the script using python 2.7. +*Warning*: the script is compatible with python 2.7 (NOT python 3). If +your default python installation is python3, you need to edit the first +line of `otawa-install.py` and replace `#!/usr/bin/python` by +`#!/usr/bin/python2` -The script is compatible with python 2.7 (NOT python 3). If your default python -installation is python3, you need to edit the first line of otawa-install.py -and replace `#!/usr/bin/python` by `#!/usr/bin/python2` +You will also need to install the OTAWA plugins for ARM, and +`lp-solve`. Go to `<otawa dir>/bin` (where `otawa dir` is the directory +where you just installed otawa) and type: -You will probably need to install the OTAWA plugins for ARM, and lp-solve. -Go to the directory containing `otawa-install.py` and type: + python otawa-install.py otawa-arm otawa-lp_solve5 - ./otawa-install.py -R <otawa dir> otawa-arm otawa-lp_solve5 +*Warning*: to install plugins, do **not** use `otawa-install.py` in +`<otawa_dir>`. -where `<otawa dir>` is the desired OTAWA installation directory. -## Setting environment ## +## Setting the environment ## -You will need to do the following: +Modify your environment variables as follows: -- put `<otawa dir>/bin` in your `PATH` environment variable -- put `<otawa dir>/lib` in your `LD_LIBRARY_PATH` environment variable +- add `<otawa dir>/bin` to variable `PATH` +- add `<otawa dir>/lib` to variable `LD_LIBRARY_PATH` ## Compiling the plug-ins ## -Go to the plugin source directory, then type make. +Go to the plugin source directory, then type `make`. ## Using a plug-in ##