diff options
| author | Amlal El Mahrouss <amlal.elmahrouss@icloud.com> | 2025-11-29 13:51:03 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-11-29 13:51:03 -0500 |
| commit | 0e06135601f94f68e1bfcacfe5d77e2cd50c1863 (patch) | |
| tree | a2dc2bfcf4764f432777a3f7056088c3f347e7f1 /README.md | |
| parent | cf6150dd3aca1b25e64fa94f8037412ed8ab6e4b (diff) | |
chore: New README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 9 insertions, 7 deletions
@@ -1,18 +1,20 @@ -<img src="./meta/png/readme-logo.png"/> +<img src="./meta/png/logo.png"/> -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. |