Update README with a migration guide

main
Duncan Ogilvie 3 years ago
parent ea01497246
commit eff967277d

@ -27,6 +27,16 @@ cmake --build build
Alternatively you can check out the [cmkr topic](https://github.com/topics/cmkr), the [build-cpp organization](https://github.com/build-cpp) or the [tests](https://github.com/build-cpp/cmkr/tree/main/tests) for more examples and templates. You can also check out the [documentation](https://build-cpp.github.io/cmkr). Alternatively you can check out the [cmkr topic](https://github.com/topics/cmkr), the [build-cpp organization](https://github.com/build-cpp) or the [tests](https://github.com/build-cpp/cmkr/tree/main/tests) for more examples and templates. You can also check out the [documentation](https://build-cpp.github.io/cmkr).
### Migrating an existing project
When migrating an existing project it's easiest to download a [cmkr release](https://github.com/build-cpp/cmkr/releases) 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 ## Command line
Optionally you can install `cmkr` in your `PATH` and use it as a utility from the command line: Optionally you can install `cmkr` in your `PATH` and use it as a utility from the command line:

@ -15,3 +15,13 @@ cmake --build build
``` ```
Alternatively you can check out the [cmkr topic](https://github.com/topics/cmkr) or the [build-cpp organization](https://github.com/build-cpp) for more examples and templates. Alternatively you can check out the [cmkr topic](https://github.com/topics/cmkr) or the [build-cpp organization](https://github.com/build-cpp) for more examples and templates.
### Migrating an existing project
When migrating an existing project it's easiest to download a [cmkr release](https://github.com/build-cpp/cmkr/releases) 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.

@ -6,7 +6,7 @@ nav_order: 0
# Index # Index
`cmkr`, pronounced "cmaker", is a modern build system based on [CMake](https://cmake.org/) and [TOML](https://toml.io). It was originally created by [Mohammed Alyousef](https://github.com/MoAlyousef). `cmkr`, pronounced "cmaker", is a modern build system based on [CMake](https://cmake.org/) and [TOML](https://toml.io).
`cmkr` parses `cmake.toml` files and generates a modern, idiomatic `CMakeLists.txt` for you. A minimal example: `cmkr` parses `cmake.toml` files and generates a modern, idiomatic `CMakeLists.txt` for you. A minimal example:

Loading…
Cancel
Save