Skip to content

Commit eff9672

Browse files
committed
Update README with a migration guide
1 parent ea01497 commit eff9672

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,16 @@ cmake --build build
2727

2828
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).
2929

30+
### Migrating an existing project
31+
32+
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:
33+
34+
```
35+
cmkr init
36+
```
37+
38+
This will bootstrap `cmake.toml` and `CMakeLists.txt` that you can then build as normal with CMake.
39+
3040
## Command line
3141

3242
Optionally you can install `cmkr` in your `PATH` and use it as a utility from the command line:

docs/getting-started.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,14 @@ cmake -B build
1414
cmake --build build
1515
```
1616

17-
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.
17+
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.
18+
19+
### Migrating an existing project
20+
21+
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:
22+
23+
```
24+
cmkr init
25+
```
26+
27+
This will bootstrap `cmake.toml` and `CMakeLists.txt` that you can then build as normal with CMake.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav_order: 0
66

77
# Index
88

9-
`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).
9+
`cmkr`, pronounced "cmaker", is a modern build system based on [CMake](https://cmake.org/) and [TOML](https://toml.io).
1010

1111
`cmkr` parses `cmake.toml` files and generates a modern, idiomatic `CMakeLists.txt` for you. A minimal example:
1212

0 commit comments

Comments
 (0)