2.4 KiB
cmkr
cmkr, pronounced "cmaker", is a modern build system based on CMake and TOML.
cmkr parses cmake.toml files and generates a modern, idiomatic CMakeLists.txt for you. A minimal example:
[project]
name = "cmkr_for_beginners"
description = "A minimal cmkr project."
[target.hello_world]
type = "executable"
sources = ["src/main.cpp"]
cmkr can bootstrap itself from CMake and consumers of your project do not need to install anything to work with it.
Getting started
The easiest way to get started is to use the cmkr_for_beginners template repository. Either open it in Gitpod, or clone the repository and run:
cmake -B build
cmake --build build
Alternatively you can check out the cmkr topic, the build-cpp organization or the tests for more examples and templates. You can also check out the documentation.
Migrating an existing project
When migrating an existing project it's easiest to download a cmkr release and put cmkr in your PATH. Then go to your project directory and run:
cmkr init
This will bootstrap cmake.toml and CMakeLists.txt that you can then build as normal with CMake.
Command line
Optionally you can install cmkr in your PATH and use it as a utility from the command line:
Usage: cmkr [arguments]
arguments:
init [executable|library|shared|static|interface] Starts a new project in the same directory.
gen Generates CMakeLists.txt file.
build <extra cmake args> Run cmake and build.
install Run cmake --install. Needs admin privileges.
clean Clean the build directory.
help Show help.
version Current cmkr version.