Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 2.94 KB

building.md

File metadata and controls

98 lines (73 loc) · 2.94 KB
hide
navigation

Build GITS

Prerequisites

You will need:

  • Git
  • Git LFS
  • A C++ compiler (MSVC on Windows, GCC on Linux; Clang support is planned)
  • A build system (Make, Visual Studio, Ninja, etc.)
  • CMake
  • Python 3

Linux

On Linux you will also need:

Clone the Repository

git clone https://github.com/intel/gits
git lfs pull
cd gits

Install Python Modules

The required Python modules are specified in the requirements.txt file (found on the root of the repository):

pip install -r requirements.txt

Additionally, you may want to use mkdocs-material to work easier with GITS documentation, in which case you would also install modules specified in the requirements.txt file found in Scripts/docs directory:

pip install -r Scripts/docs/requirements.txt

Generate and Build the Project

Below you can find examples how to build GITS for the most common cases. For other configurations (e.g. 32-bit binaries, unusual Python locations, different build systems like Ninja...) please check the relevant documentation on how you need to adjust the commands.

Since DirectX12 support is still in development you need to explicitly enable it using the following define: -DWITH_DIRECTX=ON.

=== "Windows 64-bit Rel." batch mkdir build cd build cmake -A x64 ..\ cmake --build . --config Release

=== "Windows 64-bit Rel. with DirectX12" batch mkdir build cd build cmake -A x64 ..\ -DWITH_DIRECTX=ON cmake --build . --config Release

=== "Linux 64-bit Rel." bash mkdir -p build cd build cmake -DARCH=-m64 ../ # The `-j` option without an argument sets the number of threads automatically. # You can also set it manually, e.g., `-j8` for 8 threads. # Lower thread counts decrease RAM usage, which can help with OOM errors. cmake --build . --config Release -j

Install Binaries

Before you can use GITS you need to perform the install step. Installing in this case means copying files into their destinations and setting up all paths in the configuration file.

To install GITS in the folder <gits-root-folder>\build\dist use the following command:

cd build
cmake --install . --config Release --prefix dist

Note: If you move the install folder somewhere else, you will need to manually adjust paths in config files.

Find how to use GITS here.