tomlplusplus/toml-test/README.md

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.

ℹ️ All command snippets in this document assume the working directory is the toml++ repository root.

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. Clone the toml++ repository's nlohmann/json submodule:

git submodule update --init --depth 1 external/json

4. Linux only: Install ninja and meson:

sudo apt update && sudo apt install -y locales python3 python3-pip ninja-build
sudo pip3 install meson

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:

toml-test ./bin/win64_vc143_Release_Application/tt_decoder.exe
toml-test ./bin/win64_vc143_Release_Application/tt_encoder.exe --encoder

Linux (and WSL)

# create the meson build target folder (first time only)
meson build_tt --buildtype=release -Dbuild_tt_encoder=true -Dbuild_tt_decoder=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