diff options
| author | Amlal El Mahrouss <amlal@nekernel.org> | 2025-11-30 09:41:35 -0500 |
|---|---|---|
| committer | Amlal El Mahrouss <amlal@nekernel.org> | 2025-11-30 09:41:35 -0500 |
| commit | 8772ad497772adc163957cdbf815f2d08f2eac68 (patch) | |
| tree | 6b906311b09628b0402a65fcbb9dceea66982b1f /README.md | |
| parent | 75649f69c5269204d911abccdb3b01135165cf93 (diff) | |
chore: new ReadMe, better repository hygiene.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 7 insertions, 14 deletions
@@ -1,20 +1,13 @@ -<img src="./meta/png/logo.png"/> +# SysRoot -The system repository was developed to hold the NeKernel components together. - -Acting as the software distribution for NeKernel. +Acting as the software distribution for NeKernel. this was developed to hold the its components and sysroot altogether. ## 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 (../kernel -> /system/src/kernel) -- One central system release is easier than releasing each component on its own. - -## Notes +There is three main reasons for this repository's existence: -- `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. +- Hold the codebase in a single repository, that is way more maintable than a fragmented one. +- Easier path resolutions based on a virtual root path, i.e (../kernel -> /src/kernel) +- Making releases cycle much more easier to document and do than before. -###### Copyright 2025, Amlal El Mahrouss & NeKernel.org Contributors. Licensed under Apache 2.0. +###### Copyright 2025, Amlal El Mahrouss & NeKernel.org Authors. Licensed under Apache 2.0. |
