summaryrefslogtreecommitdiffhomepage
path: root/ReadMe.md
diff options
context:
space:
mode:
Diffstat (limited to 'ReadMe.md')
-rw-r--r--ReadMe.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/ReadMe.md b/ReadMe.md
index 8516959..eb319b6 100644
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -16,4 +16,19 @@
- Run `nebuild` and pass the path to the manifest file.
+## Guide (CMake):
+
+```zsh
+# out-of-source configure + build (POSIX)
+cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+cmake --build build --target nebuild
+
+# or build the provided custom target
+cmake --build build --target build-nebuild
+
+# produce a Windows-style executable name on non-Windows hosts:
+cmake -S . -B build -DBUILD_WINDOWS=ON -DCMAKE_BUILD_TYPE=Release
+cmake --build build --target nebuild
+```
+
###### Copyright (C) 2024-2025, Amlal El Mahrouss and NeKernel.org Authors, licensed under the BSD 3 Clause license.