This page provides a quick guide to get started with the Wisdom library. The Wisdom library is designed to be lightweight and efficient, focusing on modern C++ standards and best practices. This guide will help you set up the library, understand its basic usage, and provide resources for further exploration.

Installation

There are several ways to install the Wisdom library. The recommended method is to use CMake, which allows for easy integration into your project. However, you can also clone the repository directly or download a release package. If you are using a Visual Studio project, you can also use a public NuGet package to install Wisdom.

Note: NuGet package is available at: https://www.nuget.org/packages/Wisdom/ The latest version of release for Windows can be downloaded from the GitHub releases page: https://github.com/Agrael1/Wisdom/releases/

One of the easiest ways to install Wisdom is to use CMake FetchContent or CMake Package Manager.

include(FetchContent)
FetchContent_Declare(
  Wisdom
  GIT_REPOSITORY https://github.com/Agrael1/Wisdom.git
  GIT_TAG        master
)
FetchContent_MakeAvailable(Wisdom)

Requirements

CMake 3.22 or higher
C++20 compatible compiler
Ninja build system (recommended)

On Windows you are not required to install Vulkan SDK, but it is recommended if you are working with Vulkan. Other requirements are downloaded automatically by CMake.

Build Steps

There is a simple way to build the Wisdom library using CMake. Follow these steps to build the library:

mkdir build
cd build
cmake -G Ninja ..
ninja

However that will build examples and tests as well. If you want to build only the library, you can use presets.

The library can be built using the following command:

mkdir build
cd build
cmake --preset x64-release-only-lib ..
cmake --build --preset x64-release-only-lib

This will build the library in release mode for windows. You can also use other presets to build the library in different configurations. The shown configuration is used for NuGet package.

As much as Wisdom would like to be header-only library, it is not possible due to the nature of the dependencies. But it is still possible to use it as a header-only library from CMake. For that you can use cmake targets that have suffix -headers.

Library Structure provides an overview of the library structure and its components. Initialization provides more information on how to use the library in your project.