Building PCIT Project Software

These are the building instructions for the PCIT Project software.

Requirements

• git
• A version of MSVC (required on Windows), GCC, or Clang that is C++20 compliant
• Either Microsoft Visual Studio (v143 or later), or GNU Make
• CMake (3.20.0 or later)
• Ninja
• Premake5 (5.0-beta4 or later)

Building LLVM

At the moment, PCIT relies on LLVM, so we need to build LLVM first.

1) Get the scripts

  There is a GitHub repository that contains the scripts required to download the LLVM Project source code and build it. A Windows version (.bat) and a Unix version (.sh) exist. Get the correct script for your machine.

2) Run

  Run the script. It will automatically clone the LLVM repository and compile. Here's an example with the windows version:

./build_llvm.windows.bat --build release

  To see more options with the build script (such as a debug build or skipping cloning) you can run the following:

./build_llvm.windows.bat --help

3) Completed

LLVM should now be compiled. The output will be found in directory llvm_package_20.0.8/[release|debug]/output. Inside you will find two directories: include and lib-[release|debug]. These directories will be copied or moved later.

Building PCIT-CPP

Now that we have build LLVM, we can build PCIT.

1) Clone the repository

git clone https://github.com/PCIT-Project/PCIT-CPP.git --recursive

  The --recursive argument is required to also clone Evo (a C++ standard library), the Panther standard library, and libc. These (in addition to LLVM) are the only dependencies that PCIT-CPP has.

2) Add directory for LLVM

  Inside the /PCIT-CPP/dependencies/, add the directory LLVM_build. Copy or move (whichever you prefer) the two directories discussed in step 3 of Building LLVM (include and lib-release) into this directory.

3) Configuring PCIT build system with Premake5

  Premake is a build system configurator, so Premake5 is used to configure the build system. For more information, you can run premake5 --help. Navigate to the main directory of the PCIT-CPP repository, and select one of the following methods of running Premake5:

Using Microsoft Visual Studio:

premake5 vs2022

Using GNU Make:

premake5 gmake --cc=[COMPILER]

  Replace "[COMPILER]" with one of the following options

• clang
• gcc
• mingw
• msc-v143

4) Build

Using Microsoft Visual Studio:

  Open PCIT-CPP.sln in Visual Studio, set the build configuration to ReleaseDist, and compile.

Using GNU Make:

make configuration=releasedist_linux

6) Done!

  The generated output is in ./build/[Windows|Linux]/ReleaseDist/bin/. Enjoy PCIT Project!

Next Steps

Now that you have successfully built the PCIT Project software, maybe check out one of our tutorials.