Skip to content

Install.md

Latest commit

 

History

History
96 lines (66 loc) · 2.39 KB

Install.md

File metadata and controls

96 lines (66 loc) · 2.39 KB

Installing

KAI is cross-platform across maxOS, Linux and Windows system with many internal and external components. It also has 3rd party dependencies. Don't worry too much: if the 3rd party systems can't be found to make things like a Windowed gui you will still get the TestSuite and colored text-base Console.

Downloading and updating

> git clone git@github.com:cschladetsch/KAI.git
> git submodule init
> git submodule update

Currently the list of external git repos are:

  • ENet. Cross-platform networking.
  • rang. Cross-platform Colored console output.
  • imgui. Cross-platform Immediate-mode windowing system.

Boost

Install Boost 1.72 or higher.

For Windows:

> .\bootstrap.bat
> .\b2 install debug --date-time --build=complete --with-chrono --with-filesystem --with-system --with-program_options

The same is true for Linux or macOS, just use ./ instead of .\

Building the Project

Please see BUILD.md for detailed instructions on building KAI.

Quick Start (Ubuntu/macOS)

# Using helper script (recommended)
./b    # Build with Clang++ (default)
# or
./b --gcc  # Build with GCC

# Alternative: Use the Makefile
make       # Build with Clang++ (default)
# or
make gcc   # Build with GCC

Legacy Method (Ubuntu/macOS)

> mkdir -p build && cd build
> cmake ..                        # Uses Clang++ by default
# or
> cmake .. -DBUILD_GCC=ON         # Use GCC
> cmake --build .

Windows

You will need cmake and boost installed with at least chrono, system and filesystem libraries.

Quick Start (Windows)

:: Clean any existing CMake artifacts and set up build directory
.\clean_build.bat

:: Build the project
.\build.bat

Legacy Method (Windows)

> mkdir build
> cd build
> cmake ..
> cmake --build .
:: Or open the solution file
> start *.sln

From there, build the "ALL_BUILD" project, or select a specific Test or App to test.

I suggest you include the GoogleTest integration extension for Visual Studio under windows.

Folders

The resulting interesting folders:

  • KAI/Bin. Executables and test suites.
  • KAI/Include. Root C++ include folder for KAI systems.
  • KAI/Lib. C++ static and shared libraries