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

104 lines
2.5 KiB

4 years ago
# cmkr
A CMakeLists.txt generator from TOML. Still WIP.
## Building
cmkr requires a C++17 compiler, cmake >= 3.14 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 = "3.14"
4 years ago
[project]
name = "app"
version = "0.1.0"
[[bin]]
name = "app"
type = "exe"
sources = ["src/main.cpp"]
```
This project's cmake.toml:
```toml
[cmake]
minimum = "3.14"
4 years ago
[project]
name = "cmkr"
version = "0.1.0"
4 years ago
[[bin]]
name = "cmkrlib"
type = "static"
4 years ago
sources = ["src/args.cpp", "src/gen.cpp", "src/help.cpp", "src/build.cpp"]
include-dirs = ["vendor"]
4 years ago
features = ["cxx_std_17"]
[[bin]]
name = "cmkr"
type = "exe"
sources = ["src/main.cpp"]
link-libs = ["cmkrlib"]
```
Currently supported fields:
```toml
4 years ago
[cmake] # required for top-level project
minimum = "3.14" # required
cpp-flags = [] # optional
c-flags = [] # optional
link-flags = [] # optional
4 years ago
subdirs = [] # optional
4 years ago
bin-dir = "bin" # optional
generator = "Ninja" # optional
arguments = ["CMAKE_TOOLCHAIN_FILE=/path/to/toolchain"] # optional
4 years ago
[project] # required per project
name = "app" # required
version = "0.1.0" # required
4 years ago
[find-package] # optional, runs find_package, use "*" to ignore version
boost = "1.74.0" # optional
4 years ago
[fetch-content] # optional, runs fetchContent
toml11 = { git = "https://github.com/ToruNiina/toml11", git-tag = "v3.5.0" } # optional
4 years ago
[[bin]] # required, can define several binaries
4 years ago
name = "app" # required
type = "exe" # required (exe || shared || static)
4 years ago
sources = ["src/main.cpp"] # required
include-dirs = [] # optional
4 years ago
features = [] # optional
4 years ago
defines = [] # optional
link-libs = [] # 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 --config Release
```
## Roadmap
- Support more fields.
4 years ago
- Support conditional cmake args somehow!