Echtzeitsysteme/tchecker
1
0
Fork 0
mirror of https://github.com/Echtzeitsysteme/tchecker.git synced 2024-05-20 20:00:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated installation instructions

Browse source
This commit is contained in:
Frédéric Herbreteau 2022-11-24 15:08:12 +01:00
parent d7093d3a07
commit b5434757f6
1 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
INSTALL.md
View file

@ -6,14 +6,14 @@ TChecker depends on several softwares and libraries listed below. Linux users ca
* a C++ compiler with decent C++17 support (Clang >= 3.6 or GNU g++ >= 6
should work. Apple LLVM >= 10.0.0 works)
* CMake (>= 2.8)
* CMake (>= 2.8.12)
* flex (>= 2.5.35)
* bison (>= 3.0.4)
* The Boost library (>= 1.65.0 -- probably works with earlier versions)
* Doxygen (>= 1.8.15 -- probably works with earlier versions)
* Catch2 (>= 2.7.0)
* Catch2 (>= 3.2.0) -- probably works with versions starting from v3
Catch2 can be obtained from [Catch2 github repository](https://github.com/catchorg/Catch2). Please, refer to Catch2 tutorial for [installation instructions](https://github.com/catchorg/Catch2/blob/master/docs/cmake-integration.md#installing-catch2-from-git-repository).
Notice that TChecker versions prior to v0.5 were using Catch2 v2. From release v0.5, we are using Catch2 v3. Please refer to [Catch2 GitHub repository](https://github.com/catchorg/Catch2) for sources if Catch2 is not provided by your packaging system.
# Building and installing TChecker
@ -28,9 +28,10 @@ This will create a directory `tchecker` in the current directory, that contains
## Configure the build
We use `cmake` to build the project. We recommend to build TChecker out of the source directory. This allows to easily remove the files generated by `cmake` and by the compiler. This also allows `cmake` to build a project for your favorite IDE out of the source directory. To that purpose, create a build directory:
We use `cmake` to build the project. We recommend to build TChecker out of the source directory. This allows to easily remove the files generated by `cmake` and by the compiler. This also allows `cmake` to build a project for your favorite IDE out of the source directory. A standard solution is to build a directory `build/` inside the directory `tchecker/`:
```
cd tchecker
mkdir build
cd build
```
@ -39,20 +40,20 @@ Then, the configuration depends on your system.
### Linux users
Run the following command to configure the build:
Run the following command to configure the build (from inside directory `build/`):
```
cmake ../tchecker -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/path/to/install
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/path/to/install
```
In the command above, `/path/to/install` shall be replaced by the desired installation path. Please, refer to [Configuration options](https://github.com/ticktac-project/tchecker/wiki/Installation-of-TChecker/_edit#configuration-options) for details.
### Mac OS X users
The version of `bison` that is shipped with Apple development tools is quite old, and it does not support some of the features required by TChecker. Mac OS X users will need to install a newer version using MacPorts or Brew (or another packaging system). Then, run the following command to configure the build:
The version of `bison` that is shipped with Apple development tools is quite old, and it does not support some of the features required by TChecker. Mac OS X users will need to install a newer version using MacPorts or Brew (or another packaging system). Then, run the following command to configure the build (from inside directory `build/`):
```
cmake ../tchecker -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/path/to/install -DCMAKE_PREFIX_PATH=/path/to/bison
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/path/to/install -DCMAKE_PREFIX_PATH=/path/to/bison
```
In the command above, `/path/to/bison` shall be replaced by the actual path to the newer `bison` executable. And `/path/to/install` shall be replaced by the desired installation path. Please, refer to [Configuration options](https://github.com/ticktac-project/tchecker/wiki/Installation-of-TChecker/_edit#configuration-options) for details.
@ -69,14 +70,12 @@ In the command above, `/path/to/bison` shall be replaced by the actual path to t
## Building and installing TChecker
The commands below build TChecker and its documentation in the `build` directory, and then install TChecker in the chosen installation directory (i.e. the directory specified with option `CMAKE_INSTALL_PREFIX`).
The commands below build TChecker and its documentation in the `build/` directory, and then install TChecker in the chosen installation directory (i.e. the directory specified with option `CMAKE_INSTALL_PREFIX`).
```
make -j5
make -j
make doc
make install
```
Option `-j5` launches 5 parallel compilation jobs. The value 5 shall be adapted to match the number of CPU cores on your system.
The installation procedure creates four directories: `bin`, `lib`, `include` and `share/doc/tchecker/html` in the installation directory. The TChecker tools can be found in directory `bin` (see [Using TChecker](https://github.com/ticktac-project/tchecker/wiki/Using-TChecker)). The development tools are provided in the other directories: the headers in `include`, the library in `lib`, and the Doxygen documentation in `share/doc/tchecker/html`.