Skip to content

Fix/improve doc #1423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
SGSSGene wants to merge 2 commits into
base: master
Choose a base branch
from
+25 −2
Draft

Fix/improve doc #1423

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06f2b5b
doc: clarify on the location for the 'build' folder
SGSSGene Mar 19, 2026
c53e4bd
doc: add a list of all cmake options for yaml-cpp
SGSSGene Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,15 @@ If you find a bug, post an [issue](https://github.com/jbeder/yaml-cpp/issues)! I

**Note:** If you don't use the provided installer for your platform, make sure that you add `CMake`'s bin folder to your path.

#### 1. Navigate into the source directory, create build folder and run `CMake`:
#### 1. Clone the repository
```sh
git clone https://github.com/jbeder/yaml-cpp.git
```

#### 2. Navigate into the root directory of the repository, create a build folder and run `CMake`:

```sh
cd yaml-cpp
mkdir build
cd build
cmake [-G generator] [-DYAML_BUILD_SHARED_LIBS=on|OFF] ..
Expand All @@ -44,11 +50,28 @@ cmake [-G generator] [-DYAML_BUILD_SHARED_LIBS=on|OFF] ..

* For more options on customizing the build, see the [CMakeLists.txt](https://github.com/jbeder/yaml-cpp/blob/master/CMakeLists.txt) file.

#### 2. Build it!
#### 3. Build it!
* The command you'll need to run depends on the generator you chose earlier.

**Note:** To clean up, just remove the `build` directory.

### Options
There are multiple options that can be set when calling `cmake`.

Standard:
- `YAML_BUILD_SHARED_LIBS`: Build yaml-cpp shared libraryif the library should be build as a shared or static library (default: ${BUILD_SHARED_LIBS})
- `YAML_CPP_BUILD_CONTRIB`: Enable yaml-cpp contrib in library (default: ON)
- `YAML_CPP_BUILD_TESTS`: Enable yaml-cpp tests (default: OFF)
- `YAML_CPP_BUILD_TOOLS`: Enable parse tools (default: ON)
- `YAML_CPP_CLANG_FORMAT_EXE`: Path to the clang format executable
- `YAML_CPP_DISABLE_UNINSTALL`: Disable uninstallation of yaml-cpp (default: OFF)
- `YAML_CPP_FORMAT_SOURCE`: Format source (default: ${YAML_CPP_MAIN_PROJECT})
- `YAML_CPP_INSTALL`: Enable generation of yaml-cpp install targets (default: ${YAML_CPP_MAIN_PROJECT})
- `YAML_CPP_INSTALL_CMAKEDIR`: Path to install the CMake package to
- `YAML_MSVC_SHARED_RT`: MSVC: Build yaml-cpp with shared runtime libs (/MD) (default: ON)
- `YAML_ENABLE_PIC`: Use Position-Independent Code (default: ON)
- `YAML_USE_SYSTEM_GTEST`: Use system googletest if found (default: OFF)

## How to Integrate it within your project using CMake

You can use for example FetchContent :
Expand Down
Loading