From 945e4b74c405487ea1fdd1d05759206d929d602c Mon Sep 17 00:00:00 2001 From: "Luiz \"darknessxk\" Felipe" Date: Mon, 3 May 2021 10:34:34 -0300 Subject: [PATCH] Added readme content to index page --- docs/index.markdown | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/index.markdown b/docs/index.markdown index 0671507..6bd6e76 100644 --- a/docs/index.markdown +++ b/docs/index.markdown @@ -1,6 +1,20 @@ --- -# Feel free to add content and custom Front Matter to this file. -# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults - layout: home --- + +# cmkr + +cmkr, pronounced "cmaker", is A CMakeLists.txt generator from TOML. + +See the [cmkr topic](https://github.com/topics/cmkr) for examples. Feel free to add the `cmkr` topic to your projects if you used cmkr! + +## Building + +cmkr requires a C++11 compiler, cmake >= 3.15. + +``` +git clone https://github.com/build-cpp/cmkr +cd cmkr +cmake -Bbin +cmake --build bin --parallel +```