You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
yaml-cpp is a [YAML](http://www.yaml.org/) parser and emitter in C++ matching the [YAML 1.2 spec](http://www.yaml.org/spec/1.2/spec.html).
3
+
`yaml-cpp` is a [YAML](http://www.yaml.org/) parser and emitter in C++ matching the [YAML 1.2 spec](http://www.yaml.org/spec/1.2/spec.html).
4
4
5
-
To get a feel for how it can be used, see the [Tutorial](https://github.com/jbeder/yaml-cpp/wiki/Tutorial) or [How to Emit YAML](https://github.com/jbeder/yaml-cpp/wiki/How-To-Emit-YAML). For the old API (version < 0.5.0), see [How To Parse A Document](https://github.com/jbeder/yaml-cpp/wiki/How-To-Parse-A-Document-(Old-API)).
5
+
## Usage
6
6
7
-
# Problems? #
7
+
See [Tutorial](https://github.com/jbeder/yaml-cpp/wiki/Tutorial) and [How to Emit YAML](https://github.com/jbeder/yaml-cpp/wiki/How-To-Emit-YAML) for reference. For the old API (until 0.5.0), see [How To Parse A Document](https://github.com/jbeder/yaml-cpp/wiki/How-To-Parse-A-Document-(Old-API)).
8
8
9
-
If you find a bug, post an [issue](https://github.com/jbeder/yaml-cpp/issues)! If you have questions about how to use yaml-cpp, please post it on http://stackoverflow.com and tag it [`yaml-cpp`](http://stackoverflow.com/questions/tagged/yaml-cpp).
9
+
## Any Problems?
10
10
11
-
# How to Build #
11
+
If you find a bug, post an [issue](https://github.com/jbeder/yaml-cpp/issues)! If you have questions about how to use yaml-cpp, please post it on http://stackoverflow.com and tag it [`yaml-cpp`](http://stackoverflow.com/questions/tagged/yaml-cpp).
12
12
13
-
yaml-cpp uses [CMake](http://www.cmake.org)to support cross-platform building. The basic steps to build are:
13
+
## How to Build
14
14
15
-
1. Download and install [CMake](http://www.cmake.org) (Resources -> Download).
15
+
`yaml-cpp` uses [CMake](http://www.cmake.org) to support cross-platform building. Install [CMake](http://www.cmake.org)_(Resources -> Download)_ before proceeding. The basic steps to build are:
16
16
17
-
**Note:** If you don't use the provided installer for your platform, make sure that you add CMake's bin folder to your path.
17
+
**Note:** If you don't use the provided installer for your platform, make sure that you add `CMake`'s bin folder to your path.
18
18
19
-
2. Navigate into the source directory, and type:
19
+
#### 1. Navigate into the source directory, create build folder and run `CMake`:
* 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:
33
-
* On Windows, you might use "Visual Studio 12 2013" to generate a Visual Studio 2013 solution or "Visual Studio 14 2015 Win64" to generate a 64-bit Visual Studio 2015 solution.
34
-
* On OS X, you might use "Xcode" to generate an Xcode project
35
-
* On a UNIX-y system, simply omit the option to generate a makefile
27
+
* The `generator` option is the build system you'd like to use. Run `cmake` without arguments to see a full list of available generators.
28
+
* On Windows, you might use "Visual Studio 12 2013" (VS 2013 32-bits), or "Visual Studio 14 2015 Win64" (VS 2015 64-bits).
29
+
* On OS X, you might use "Xcode".
30
+
* On a UNIX-like system, omit the option (for a Makefile).
36
31
37
-
* yaml-cpp defaults to building a static library, but you may build a shared library by specifying `-DYAML_BUILD_SHARED_LIBS=ON`.
32
+
*`yaml-cpp` builds a static library by default, you may want to build a shared library by specifying `-DYAML_BUILD_SHARED_LIBS=ON`.
38
33
39
34
* For more options on customizing the build, see the [CMakeLists.txt](https://github.com/jbeder/yaml-cpp/blob/master/CMakeLists.txt) file.
40
35
41
-
4. Build it!
36
+
#### 2. Build it!
37
+
* The command you'll need to run depends on the generator you chose earlier.
42
38
43
-
5. To clean up, just remove the `build` directory.
39
+
**Note:** To clean up, just remove the `build` directory.
44
40
45
-
# Recent Release #
41
+
##Recent Releases
46
42
47
-
[yaml-cpp 0.6.0](https://github.com/jbeder/yaml-cpp/releases/tag/yaml-cpp-0.6.0)has been released! This release requires C++11, and no longer depends on Boost.
43
+
[yaml-cpp 0.6.0](https://github.com/jbeder/yaml-cpp/releases/tag/yaml-cpp-0.6.0) released! This release requires C++11, and no longer depends on Boost.
48
44
49
45
[yaml-cpp 0.3.0](https://github.com/jbeder/yaml-cpp/releases/tag/release-0.3.0) is still available if you want the old API.
50
46
@@ -59,3 +55,4 @@ The autogenerated API reference is hosted on [CodeDocs](https://codedocs.xyz/jbe
59
55
The following projects are not officially supported:
0 commit comments