From a44f4ee57243be13599bd687c362d12670dcb1d2 Mon Sep 17 00:00:00 2001 From: Mohammed Alyousef Date: Wed, 9 Sep 2020 15:10:23 +0300 Subject: [PATCH] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 37d1a9b..31859b4 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,17 @@ A CMakeLists.txt generator from TOML. Still WIP. ## Building +cmkr requires a C++17 compiler and git. It depends on toml11 by ToruNiina, which is added as a git submodule. ``` git clone https://github.com/moalyousef/cmkr cd cmkr +git submodule update --init --recursive cmake -S. -Bbin cmake --build bin ``` ## Usage -cmkr parses cmake.toml files at the project directory. A basic hello world format with the minimum required fields: +cmkr parses cmake.toml files (using toml11) at the project directory. A basic hello world format with the minimum required fields: ```toml [cmake] minimum_required = "3.0" @@ -68,4 +70,4 @@ cmkr build -DCMAKE_TOOLCHAIN_FILE=/path/to/toolchain -DCMAKE_BUILD_TYPE=Release ## Roadmap - Support more fields. -- Support conditional cmake args somehow! \ No newline at end of file +- Support conditional cmake args somehow!