Installation guide

To compile the library, you'll need:

• A C++ compiler (e.g., GCC, Clang, or MSVC)
• Rake, a build automation tool.

Compile the Library

Open a terminal in the project's root directory and run the following command:

rake

or if the OS is not detected correctly

rake build_osx   # compile for OSX
rake build_linux # compile for linux
rake build_win   # compile for WINDOWS

This will compile the source files and generate the library files in the following structure:

lib/
  ├── include/  # Header files
  └── lib/      # Compiled library files

check the library

To run the tests

rake run       # for linux/OSX
rake run_win   # for windows

Integrate into Your Project

• Include Headers: Add the include/ directory to your project's include path.

  g++ -I/path/to/lib/include your_project.cpp -o your_project

• Link the Library: Use the -L and -l flags to link against the library:

  g++ -L/path/to/lib/lib -lyourlibrary your_project.cpp -o your_project

Verify the Installation

Compile and run your project to verify that it works with the newly linked library.