Go to file
João Marcos Pereira Bezerra 196a6af113
Review README.md changes
2019-10-01 12:15:25 -03:00
include/yaml-cpp Remove extraneous conversion from string -> c_str -> string (#739) 2019-09-14 20:24:17 -04:00
src Improve error messages on operator[] or as<> (#656) 2019-04-17 08:44:09 -05:00
test Set C++ standard options in CMake per-target instead of globally (#735) 2019-09-10 07:51:13 -07:00
util Set C++ standard options in CMake per-target instead of globally (#735) 2019-09-10 07:51:13 -07:00
.clang-format Update .clang-format to use C++ 11 style. 2016-04-01 20:06:28 -05:00
.codedocs test: Upgrade googlemock 1.7.0 to googletest 1.8.0 2017-08-24 22:49:17 -05:00
.gitignore Enable items to be removed from a sequence (#582) 2018-05-14 08:50:28 -05:00
.travis.yml travis: Exclude linux/clang from the build matrix 2017-08-24 22:49:17 -05:00
CMakeLists.txt Fix shared lib build with new YAML_BUILD_SHARED_LIBS option (#737) 2019-09-14 21:21:35 -04:00
CONTRIBUTING.md Update CONTRIBUTING.md 2016-03-28 23:47:21 -05:00
install.txt Added newline to install and license files 2009-12-21 20:35:27 +00:00
LICENSE Rename license file and update copyright date. 2015-03-30 20:32:46 -05:00
README.md Review README.md changes 2019-10-01 12:15:25 -03:00
yaml-cpp-config-version.cmake.in Add yaml-cpp-config.cmake and yaml-cpp-config-version.cmake files for importing yaml-cpp into external projects (through find_package). 2015-01-24 11:21:26 -06:00
yaml-cpp-config.cmake.in Add yaml-cpp-config.cmake and yaml-cpp-config-version.cmake files for importing yaml-cpp into external projects (through find_package). 2015-01-24 11:21:26 -06:00
yaml-cpp.pc.cmake Fix paths in pkg-config file (#556) 2018-02-02 09:12:34 -06:00

yaml-cpp Build Status Documentation

yaml-cpp is a YAML parser and emitter in C++ matching the YAML 1.2 spec.

Usage

See Tutorial and How to Emit YAML for reference. For the old API (until 0.5.0), see How To Parse A Document.

Any Problems?

If you find a bug, post an issue! If you have questions about how to use yaml-cpp, please post it on http://stackoverflow.com and tag it yaml-cpp.

How to Build

yaml-cpp uses CMake to support cross-platform building. Install CMake (Resources -> Download) before proceeding. The basic steps to build are:

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:

mkdir build
cd build
cmake [-G generator] [-YAML_BUILD_SHARED_LIBS=on|OFF] ..
  • The generator option is the build system you'd like to use. Run cmake without arguments to see a full list of available generators.

    • On Windows, you might use "Visual Studio 12 2013" (VS 2013 32-bits), or "Visual Studio 14 2015 Win64" (VS 2015 64-bits).
    • On OS X, you might use "Xcode".
    • On a UNIX-like system, omit the option (for a Makefile).
  • yaml-cpp builds a static library by default, you may want to build a shared library by specifying -YAML_BUILD_SHARED_LIBS=ON.

  • For more options on customizing the build, see the CMakeLists.txt file.

2. 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.

Recent Releases

yaml-cpp 0.6.0 released! This release requires C++11, and no longer depends on Boost.

yaml-cpp 0.3.0 is still available if you want the old API.

The old API will continue to be supported, and will still receive bugfixes! The 0.3.x and 0.4.x versions will be old API releases, and 0.5.x and above will all be new API releases.