summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2026-02-22 13:53:13 +0100
committerAmlal El Mahrouss <amlal@nekernel.org>2026-02-22 13:53:13 +0100
commitf2a51c92090d757ab04de1a0e2f4e6f757ff1fb6 (patch)
treeef47a1e20423f298663a315b9fc7c2970f106dda
parentfe6f35819564eda350778b84e12baea12f8e3e73 (diff)
chore: reworking README and update modules.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index ccdb9cf..0ac2a3d 100644
--- a/README.md
+++ b/README.md
@@ -9,9 +9,21 @@
</p>
</div>
-This is the software distribution of NeKernel.org
+## Abstract:
-## The Rationale:
+This is the software distribution of NeKernel.org. Designed the contain all of the stack together. Facilities are provided to build compiler toolchains as well.
+
+## Getting Started:
+
+Please clone the repository using Git:
+
+```sh
+git clone --recurse-submodules -j8 git@github.com:nekernel-org/src.git
+```
+
+And
+
+## Rationale:
There is three main reasons for this repository's existence: