Skip to content

Build instructions for Linux

ameci-iis edited this page Sep 11, 2024 · 1 revision

You need to have CMake, a generator (e.g. GNU Make or Ninja), and a toolchain (e.g. GCC or Clang) installed. For installation instructions, consult the documentation of your distribution's package manager.

  1. Clone the project and make a build folder.
    $ git clone [email protected]:Fraunhofer-IIS/mmtau2mhasconverterlib.git
    $ mkdir -p build_linux
    
  2. Configure the project using CMake.
    $ cmake -S mmtau2mhasconverterlib -B build_linux -DCMAKE_TOOLCHAIN_FILE=<path/to/toolchain-file.cmake> -DCMAKE_BUILD_TYPE=Release
    
    Use a toolchain file and set the path to it correctly. If you have multiple generators installed, you can use the -G option to select the desired generator
  3. Build the project.
    $ cmake --build build_linux
    
    The build/ folder should, dependent on the set configuration, now contain:
    • lib/ subfolder with the built project libraries
    • doc/ subfolder with the generated Doxygen documentation

Toolchain files

The parameter CMAKE_TOOLCHAIN_FILE is added in step 2 of the build instructions above and should point to a file containing a toolchain description. You can find more information on that topic here.

We recommend using one of the following toolchain files: