Home

Documentation

Visit https://elshize.github.io/irkit/docs/html/ for Doxygen documentation.

Build Dependencies

• Boost,
• ZLIB,
• gumbo-parser.

The rest of the dependencies will be fetched automatically. See submodules directory for more details.

Installation

Use cmake to build, run tests, and install the library.

cd build_folder  # where you want it built
cmake src_folder # the root of the cloned repository
cmake --build .  # build
ctest            # run tests (optional)
sudo cmake --build . --target install  # install

Using as Library

As a Submodule

You can include the project as a subdirectory with add_subdirectory(path_to_irkit). Then, irkit target will be available for you to use:

link_target_libraries(your_lib_or_exec ... irkit ...)

Preinstalled

(You can use https://github.com/elshize/irkit_based_example as an example.)

First, you have to make sure that even the submodule dependencies are installed to use all available features. You can do that manually, or you can leave it to our build system by passing IRKit_INSTALL_SUBMODULES variable:

cd build_folder
cmake -D IRKit_INSTALL_SUBMODULES:BOOL=ON src_folder
cmake --build .
sudo cmake --build . --target install

Once all dependencies are ready, you can call find_package from your CMakeLists.txt to import target irkit:

find_package(irkit REQUIRED)
.
.
.
link_target_libraries(your_lib_or_exec ... irkit ...)