From eff967277dd95a86761b7f359ce709673cafee7b Mon Sep 17 00:00:00 2001 From: Duncan Ogilvie Date: Thu, 23 Dec 2021 13:26:31 +0100 Subject: [PATCH] Update README with a migration guide --- README.md | 10 ++++++++++ docs/getting-started.md | 12 +++++++++++- docs/index.md | 2 +- 3 files changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a6a3f00..24686b2 100644 --- a/README.md +++ b/README.md @@ -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). +### 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 Optionally you can install `cmkr` in your `PATH` and use it as a utility from the command line: diff --git a/docs/getting-started.md b/docs/getting-started.md index 5e3a9c1..aaf26da 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -14,4 +14,14 @@ cmake -B build 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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 4ee9fdc..858e9b0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,7 @@ nav_order: 0 # 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: