Skip to content

Commit d984271

Browse files
committed
docs: list the most important cmake flags to build arkscript
1 parent 6f235d9 commit d984271

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

content/docs/prologue/building.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ git checkout tags/<tag>
7676

7777
Different CMake switches are available to customise the build:
7878

79-
- `-DCMAKE_BUILD_TYPE` is required to specify the build type (`Debug`, `Release`, `RelWithDebInfo`) to toggle LTO
79+
- `-DCMAKE_BUILD_TYPE` is **required** to specify the build type (`Debug`, `Release`, `RelWithDebInfo`) to toggle LTO
8080
- `-DARK_BUILD_EXE` to generate an executable, defaults to Off, building a shared library
8181
- `-DARK_ENABLE_SYSTEM` to enable `sys:exec` (execute shell commands without restrictions), defaults to On
8282
- `-DARK_BUILD_MODULES` to build the modules, defaults to Off
@@ -87,6 +87,13 @@ Different CMake switches are available to customise the build:
8787
- `-DARK_TESTS` to build the unit tests (separate target named `unittests`)
8888
- `-DARK_COVERAGE` to enable coverage analysis ; only works in conjunction with `-DARK_TESTS`, enables the `coverage` target: `cmake --build build --target coverage`
8989

90+
If you're building the language to use (and not embedding it in a project), the most important switches you'll want are:
91+
```
92+
-DCMAKE_BUILD_TYPE=Release
93+
-DARK_BUILD_EXE=On
94+
-DARK_UNITY_BUILD=On
95+
```
96+
9097
### Building on Windows
9198

9299
Requirements:

0 commit comments

Comments
 (0)