loot/libloot
0
0
Fork 0
mirror of https://github.com/loot/libloot.git synced 2026-07-27 14:16:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update the root and C++ readmes

Browse Source
This commit is contained in:
Oliver Hamlet
2025-05-08 19:27:13 +01:00
parent 7b870488c4
commit 98fdb130a6
2 changed files with 28 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cpp/README.md
+11 -2
View File
@@ -1,6 +1,6 @@
# libloot-rs C++ wrapper
This is an **experimental** wrapper around the Rust reimplementation of libloot that provides a C++ interface that's ABI-compatible with libloot v0.26.1.
This is a wrapper around libloot that provides a C++ interface that's ABI-compatible with libloot v0.26.1.
The wrapper has two layers:
@@ -9,6 +9,15 @@ The wrapper has two layers:
## Building
libloot uses the following CMake variables to set build parameters:
Parameter | Values | Default |Description
----------|--------|---------|-----------
`BUILD_SHARED_LIBS` | `ON`, `OFF` | `ON` | Whether or not to build a shared libloot binary.
`LIBLOOT_BUILD_TESTS` | `ON`, `OFF` | `ON` | Whether or not to build libloot's tests.
`LIBLOOT_INSTALL_DOCS` | `ON`, `OFF` | `ON` | Whether or not to install libloot's docs (which need to be built separately).
`RUN_CLANG_TIDY` | `ON`, `OFF` | `OFF` | Whether or not to run clang-tidy during build. Has no effect when using CMake's MSVC generator.
### Windows
To build a release build with debug info:
@@ -44,7 +53,7 @@ cmake --build build --parallel
### Tests
The build process also builds a copy of the public API tests from C++ libloot v0.26.1 by default. To skip building the tests, pass `-DLIBLOOT_BUILD_TESTS=OFF` when first running CMake.
The build process also builds the test suite by default. To skip building the tests, pass `-DLIBLOOT_BUILD_TESTS=OFF` when first running CMake.
If built, the tests can be run using: