From 3209f8821920db1e92413b4eaf4a570e9c3fac7b Mon Sep 17 00:00:00 2001 From: 😄 Amlal El Mahrouss Date: Fri, 20 Mar 2026 06:58:48 +0100 Subject: Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 😄 Amlal El Mahrouss --- README.md | 44 +++++++++++++++++++------------------------- 1 file changed, 19 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 2624b17..4b4a3b4 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,33 @@ -
-

- 🍯 The NeSystem: -

-

- License -

-
+# 🍯 The NeSystem + +License +![GitHub Repo stars](https://img.shields.io/github/stars/ne-foss-org/ne-system) + +# About: + +A project that aims to provide an alternative for backend systems. (Edge Computing, Storage Systems, etc.) made to be easily deployable and forkable as well. ## Getting Started: +## Building: + +You will need: + +- `nebuild`, the in-house build system. +- `MinGW` or `Clang`, depending on the HAL/target ISA. +- `CoreUtils`, for the core compiler utilities. + +Please follow the the tutorials in `/src/reference` to get started. + ### Quick Install: ```sh curl -fsSL http://install.nekernel.org | sh ``` -### Long Version: +### Full installation: Please clone the repository using Git: @@ -42,22 +52,6 @@ There is three main reasons for this repository's existence: - Easier path resolutions based on a virtual root path, i.e (../kernel -> /src/kernel) - Easier cycles and vetting for Ne.org releases. -## Building: - -You will need: - -- `nebuild` for the kernel build system. -- `MinGW` or `Clang` depending on the HAL/target ISA. -- `GNU CoreUtils` for the core compiler utilities. - -Please follow the the tutorials in `/src/reference` to get started. - -## Love the work? - -Give us a star on GitHub! - -![GitHub Repo stars](https://img.shields.io/github/stars/ne-foss-org/ne_system) - ## The Package Registry: We have a package registry for the NeSystem: [https://github.com/ne-ci-org/ports](https://github.com/ne-ci-org/ports) package porting happens here. -- cgit v1.2.3