Go to file

theNerd247 19f048c615 made installing documentation optional * fixed bug mentioned in #345 about `make install` giving an error when `make doc` isn't called previously		2016-05-14 17:55:45 -04:00
include/yaml-cpp	Update doc, formatting for emit.h.	2016-05-12 23:23:05 -05:00
src	Update doc, formatting for emit.h.	2016-05-12 23:23:05 -05:00
test	Fix for broken build on cygwin using gcc - "error '[fileno, strdup, fdopen]' are not in scope" (#374 )	2016-05-11 23:00:34 -05:00
util	Add features to read binary:	2016-01-30 18:28:27 -06:00
.clang-format	Update .clang-format to use C++ 11 style.	2016-04-01 20:06:28 -05:00
.codedocs	Use CodeDocs.xyz for Doxygen documentation (#375 )	2016-05-12 08:55:45 -05:00
.gitignore	Add a .gitignore file.	2015-03-31 09:33:49 +01:00
.travis.yml	Turn travis email notifications back on.	2016-04-01 20:27:26 -05:00
CMakeLists.txt	made installing documentation optional	2016-05-14 17:55:45 -04:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2016-03-28 23:47:21 -05:00
Doxyfile.in	added filter to remove gmock source code from doxygen	2016-01-10 21:00:52 -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	Merge branch 'master' into doxygen-update	2016-05-14 17:55:24 -04: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	Fixed includedir for the .pc.cmake file	2011-05-29 02:17:49 +00:00

README.md

yaml-cpp

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

To get a feel for how it can be used, see the Tutorial or How to Emit YAML. For the old API (version < 0.5.0), see How To Parse A Document.

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. The basic steps to build are:

Download and install CMake (Resources -> Download).

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

Navigate into the source directory, and type:

mkdir build cd build
Run CMake. The basic syntax is:

cmake [-G generator] [-DBUILD_SHARED_LIBS=ON|OFF] ..

The generator is whatever type of build system you'd like to use. To see a full list of generators on your platform, just run cmake (with no arguments). For example:
- On Windows, you might use "Visual Studio 12 2013" to generate a Visual Studio 2013 solution
- On OS X, you might use "Xcode" to generate an Xcode project
- On a UNIX-y system, simply omit the option to generate a makefile
yaml-cpp defaults to building a static library, but you may build a shared library by specifying -DBUILD_SHARED_LIBS=ON.
- By default the build is configured to generate doxygen documentation for the library. If you'd like to turn this off use -DUSE_DOXYGEN=OFF. If you do use doxygen then make sure you run: make doc before running make install.
For more options on customizing the build, see the CMakeLists.txt file.

Build it!
To clean up, just remove the build directory.

Recent Release

yaml-cpp 0.5.3 has been released! This is a bug fix release. It also will be the last release that uses Boost; futures releases will require C++11 instead.

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.