summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0a3eb57
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# NeBuild
+
+![CI](https://github.com/nekernel-org/nebuild/actions/workflows/c-cpp.yml/badge.svg)
+![CI](https://github.com/nekernel-org/nebuild/actions/workflows/c-cpp-dev.yml/badge.svg)
+[![License: GPL-3.0](https://img.shields.io/badge/license-BSD--3.0-blue.svg)](LICENSE)
+
+## Requirements:
+
+- GNU C++
+- GNU Make
+
+## Guide (GNU Make):
+
+- Run make `build-nebuild-core` and `build-nebuild` to build from source.
+
+## Guide (NeBuild):
+
+- Run `nebuild` and pass the path to the manifest file to build from source:
+
+```sh
+nebuild targets/osx.json
+```
+
+## Guide (CMake):
+
+- Use CMake to build `nebuild` from source:
+
+```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.