From 0e06135601f94f68e1bfcacfe5d77e2cd50c1863 Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Sat, 29 Nov 2025 13:51:03 -0500 Subject: chore: New README.md --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2146426..3745fe1 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,20 @@ - + -The system repository was developed to hold the NeKernel components together. Acting as the software distribution for NeKernel. +The system repository was developed to hold the NeKernel components together. -## Purpose +Acting as the software distribution for NeKernel. -The purpose is the following: +## Reasons: + +There is three main reasons for this repository: - Hold the codebase in a single repository, it is way more maintable than a fragmented one. -- Easier paths based on the `system` path, i.e (../nekernel -> /system/dev/nekernel) +- Easier paths based on the `system` path, i.e (../kernel -> /system/src/kernel) - One central system release is easier than releasing each component on its own. ## Notes -- `include` is for the system library (libSystem) and other third-party installed libraries headers. +- `include` is for the system libraries (libSystem, libDDK) and other third-party installed libraries headers. - `devices` and `network` are for network and standard devices on NeKernel. -###### Copyright 2025 - Amlal El Mahrouss & NeKernel.org Contributors. Licensed under Apache 2.0. +###### Copyright 2025, Amlal El Mahrouss & NeKernel.org Contributors. Licensed under Apache 2.0. -- cgit v1.2.3