diff options
Diffstat (limited to 'tomlplusplus/toml-test/README.md')
| -rw-r--r-- | tomlplusplus/toml-test/README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/tomlplusplus/toml-test/README.md b/tomlplusplus/toml-test/README.md new file mode 100644 index 0000000000..92887690bf --- /dev/null +++ b/tomlplusplus/toml-test/README.md @@ -0,0 +1,52 @@ +# Encoder and Decoder for [toml-test] + +> ℹ️ _The contents of this directory relate to testing with the [toml-test] suite, **not** anything to do with running the library's unit-tests. +> For information about running the unit-tests see [CONTRIBUTING](../CONTRIBUTING.md)._ +> +> ℹ️ _All command snippets in this document assume the working directory is the toml++ repository root._ + +<br> + +## Prequisites + +For this document to make sense, you will need to: + +1. Follow the installation instructions from the [toml-test] README to compile the `toml-test` runner +2. Add `toml-test` as an alias or have it on the system PATH +3. **Linux only:** Install `ninja` and `meson`: + +```bash +sudo apt update && sudo apt install -y python3 python3-pip ninja-build +sudo pip3 install meson +``` + +<br> + +## Building and Testing the Encoder and Decoder + +### Windows with Visual Studio + +Open `toml++.sln` and build the two projects in the `toml-test` solution folder. They'll be compiled in some target-specific subfolder under `/bin` in the repo root. Then run `toml-test` against them: + +```bash +toml-test ./bin/win64_vc143_Release_Application/tt_decoder.exe +toml-test ./bin/win64_vc143_Release_Application/tt_encoder.exe --encoder +``` + +### Linux (and WSL) + +```bash +# create the meson build target folder (first time only) +meson build_tt --buildtype=release -Dbuild_tt=true -Dgenerate_cmake_config=false + +# build and run +cd build_tt +ninja && toml-test ./toml-test/tt_decoder && toml-test ./toml-test/tt_encoder --encoder +``` + +> ℹ️ Pass `-Duse_vendored_libs=false` to meson if you wish to use the system-installed version +> of nlohmann/json rather than the vendored one. + +[toml-test]: https://github.com/toml-lang/toml-test +[contributing]: ./../CONTRIBUTING.md +[meson]: https://mesonbuild.com/ |