summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-03-31 16:57:06 +0200
committerAmlal El Mahrouss <amlal@nekernel.org>2025-03-31 16:57:06 +0200
commit4edacbb20e2dd8c0e71cfbfc6712654c36f9c4e5 (patch)
tree069e51ec88a6c6a7443e7b095e9678ae689848b7
parent42d16947690577afd1f8f75ebc80041cd36588fd (diff)
meta: better readme to introduce the kernel.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
-rw-r--r--README.md10
-rw-r--r--docs/svg/OS_DESIGN.pngbin0 -> 22504 bytes
2 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index a6e4ed95..8f683c08 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,15 @@
[![License: GPL-3.0](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](LICENSE)
[![QEMU Tested](https://img.shields.io/badge/QEMU-Tested-success)](#)
-## Notice for Documentation:
+## Brief:
+
+A kernel for engineers who want a custom solution for their stack, written mostly in C++ it aims to provide a base for other projects/products.
+
+## User Friendly Diagram:
+
+![Diagram](docs/svg/OS_DESIGN.png)
+
+## Notice for Doxygen:
Use the doxygen command to build documentation.
<br/>
diff --git a/docs/svg/OS_DESIGN.png b/docs/svg/OS_DESIGN.png
new file mode 100644
index 00000000..05fbee16
--- /dev/null
+++ b/docs/svg/OS_DESIGN.png
Binary files differ