summaryrefslogtreecommitdiffhomepage
path: root/ReadMe.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-11-29 21:16:54 -0500
committerGitHub <noreply@github.com>2025-11-29 21:16:54 -0500
commit0c4df216280fb31a18f933a0fc9abd8efdc81305 (patch)
tree20a18b5820519da8127a11c72ab1ebd523050ca9 /ReadMe.md
parente43bfe755f98022252e56aa89431edc983babb93 (diff)
parent1b5097d5035cb73a4845e914021851bf81186bfb (diff)
Merge pull request #14 from nekernel-org/dev
chore: NeBuildKit: Architectural improvements over {Defines+Includes}.h
Diffstat (limited to 'ReadMe.md')
-rw-r--r--ReadMe.md22
1 files changed, 10 insertions, 12 deletions
diff --git a/ReadMe.md b/ReadMe.md
index eb319b6..bb4d4dc 100644
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -10,25 +10,23 @@
## Guide (GNU Make):
-- Run make `build-nebuild-core` and `build-nebuild`.
+- Run make `build-nebuild-core` and `build-nebuild` to build from source.
## Guide (NeBuild):
-- Run `nebuild` and pass the path to the manifest file.
+- Run `nebuild` and pass the path to the manifest file to build from source:
-## Guide (CMake):
+```sh
+nebuild targets/osx.json
+```
-```zsh
-# out-of-source configure + build (POSIX)
-cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
-cmake --build build --target nebuild
+## Guide (CMake):
-# or build the provided custom target
-cmake --build build --target build-nebuild
+- Use CMake to build `nebuild` from source:
-# 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
+```zsh
+cmake -S . -B build
+cmake --build build
```
###### Copyright (C) 2024-2025, Amlal El Mahrouss and NeKernel.org Authors, licensed under the BSD 3 Clause license.