From 4edacbb20e2dd8c0e71cfbfc6712654c36f9c4e5 Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Mon, 31 Mar 2025 16:57:06 +0200 Subject: meta: better readme to introduce the kernel. Signed-off-by: Amlal El Mahrouss --- README.md | 10 +++++++++- docs/svg/OS_DESIGN.png | Bin 0 -> 22504 bytes 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 docs/svg/OS_DESIGN.png 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.
diff --git a/docs/svg/OS_DESIGN.png b/docs/svg/OS_DESIGN.png new file mode 100644 index 00000000..05fbee16 Binary files /dev/null and b/docs/svg/OS_DESIGN.png differ -- cgit v1.2.3