Readme updates [skip ci]

This commit is contained in:
Mark Gillard 2020-06-08 21:47:31 +03:00 committed by GitHub
parent 13a02140c7
commit 041d7a7a44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -78,11 +78,11 @@ You'll find some more code examples in the `examples` directory, and plenty more
# Adding toml++ to your project
`toml++` comes in two flavours: Single-header and Regular. The API is the same for both.
## 🍦 Single-header flavour
### 🍦 Single-header flavour
1. Drop `toml.hpp` wherever you like in your source tree
2. There is no step two
## 🍨 Regular flavour
### 🍨 Regular flavour
1. Add `tomlplusplus/include` to your include paths
2. `#include <toml++/toml.h>`
@ -131,7 +131,7 @@ support for a number of unreleased features from the [TOML master] and some sane
The library advertises the most recent numbered language version it fully supports via the preprocessor
defines `TOML_LANG_MAJOR`, `TOML_LANG_MINOR` and `TOML_LANG_PATCH`.
## 🟡 **Unreleased features:**
### 🔸 **Unreleased language features:**
- [#516]: Allow newlines and trailing commas in inline tables
- [#562]: Allow hex floating-point values
- [#644]: Support `+` in key names
@ -141,14 +141,14 @@ defines `TOML_LANG_MAJOR`, `TOML_LANG_MINOR` and `TOML_LANG_PATCH`.
> _`#define TOML_UNRELEASED_FEATURES 1` to enable these features (see [Configuration](#Configuration))._
## 🟢 **TOML v1.0.0-rc.1:**
### 🔹 **TOML v1.0.0-rc.1:**
All features supported, including:
- [#356]: Allow leading zeros in the exponent part of a float
- [#567]: Control characters are not permitted in comments
- [#571]: Allow raw tabs inside strings
- [#665]: Make arrays heterogeneous
## 🟢 **TOML v0.5.0:**
### 🔹 **TOML v0.5.0:**
All features supported.
<br>
@ -165,6 +165,18 @@ If you wish to submit a pull request, please see [CONTRIBUTING] for all the deta
UTF-8 decoding is performed using a state machine based on Bjoern Hoehrmann's '[Flexible and Economical UTF-8 Decoder]'.
### With thanks to:
- **@bjadamson** - Reported some bugs and helped design a new feature
- **@bobfang1992** - Reported a bug and created a [wrapper in python](https://github.com/bobfang1992/pytomlpp)
- **@GiulioRomualdi** - Added cmake+meson support
- **@mosra** - Created the awesome [m.css] used to generate the API docs
- **@ned14** - Reported a bunch of bugs and helped design some new features
- **@prince-chrismc** - Added `toml++` to ConanCenter, and fixed some typos
- **@rbrugo** - helped design a new feature
- **@shdnx** - Fixed a bug on GCC 8.2.0 and some meson config issues
- **@traversaro** - Added vcpkg support and reported a bunch of bugs
- **@ximion** - Added support for installation with meson
<br>
# Contact
@ -207,3 +219,4 @@ though you're welcome to reach out via other means. In order of likely response
[#709]: https://github.com/toml-lang/toml/pull/709
[LICENSE-utf8-decoder]: ./LICENSE-utf8-decoder
[something better than std::optional]: https://github.com/TartanLlama/optional
[m.css]: https://mcss.mosra.cz/documentation/doxygen