Idea-Studios/libgit2
2
0
Fork 0
mirror of https://github.com/libgit2/libgit2.git synced 2026-06-22 06:26:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add instructions to build examples

Browse Source 
To build the examples, they must be included in the main build
using the following command:

    cmake -DBUILD_EXAMPLES=True ..
This commit is contained in:
thymusvulgaris
2024-06-28 13:32:49 +01:00
parent 585210ab21
commit febc6558fe
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -224,6 +224,10 @@ On most systems you can build the library using the following commands
$ cmake ..
$ cmake --build .
To include the examples in the build, use `cmake -DBUILD_EXAMPLES=True ..` instead of `cmake ..`.
The built executable for the examples can then be found in `build/examples`, relative to the toplevel directory.
Alternatively you can point the CMake GUI tool to the CMakeLists.txt file and generate platform specific build project or IDE workspace.
If you're not familiar with CMake, [a more detailed explanation](https://preshing.com/20170511/how-to-build-a-cmake-based-project/) may be helpful.