You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
cmkr/README.md

75 lines
2.0 KiB

4 years ago
# cmkr
A CMakeLists.txt generator from TOML. Still WIP.
## Building
4 years ago
cmkr requires a C++17 compiler, cmake and git. It depends on toml11 by ToruNiina, which is added as a git submodule.
```
git clone https://github.com/moalyousef/cmkr
cd cmkr
4 years ago
git submodule update --init --recursive
cmake -S. -Bbin
cmake --build bin
```
## Usage
4 years ago
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"
[project]
name = "cmkr"
version = "0.1.0"
[[bin]]
name = "cmkr"
type = "exe"
sources = ["src/main.cpp"]
```
Currently supported fields:
```toml
[cmake] # required
minimum_required = "3.0" # required
# cpp_flags = [] # optional
# c_flags = [] # optional
# linker_flags = [] # optional
# subdirs = [] # optional
[project] # required
name = "cmkr" # required
version = "0.1.0" # required
[dependencies] # optional, runs find_package, use "*" to ignore version
boost = "1.74.0" # optional
4 years ago
[[bin]] # required, can define several binaries
name = "cmkr" # required
type = "exe" # required (exe || shared || static)
sources = ["src/main.cpp", "src/args.cpp", "src/gen.cpp"] # required
include_directories = ["vendor"] # optional
compile_features = ["cxx_std_17"] # optional
4 years ago
# definitions = [] # optional
# link_libraries = [] # optional
```
The cmkr executable can be run from the command-line:
```
Usage: cmkr [arguments]
arguments:
init [exe|shared|static] Starts a new project in the same directory.
gen Generates CMakeLists.txt file.
4 years ago
build [extra cmake args] Run cmake and build.
help Show help.
version Current cmkr version.
```
The build command invokes cmake and the default build-system on your platform, it also accepts extra cmake arguments:
```
4 years ago
cmkr build -GNinja -DCMAKE_TOOLCHAIN_FILE=/path/to/toolchain -DCMAKE_BUILD_TYPE=Release
```
## Roadmap
- Support more fields.
4 years ago
- Support conditional cmake args somehow!