diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 62 |
1 files changed, 30 insertions, 32 deletions
@@ -1,36 +1,33 @@ -<!-- Read Me of NeKernel Sources --> +<!-- ReadMe of the NeSystem --> -<div align="center"> - <h1> - <b>The Ne.org System.</b> - </h1> - <p> - <a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache--2.0-blue.svg" alt="License"></a> - </p> -</div> +# 🍯 The NeSystem -## Primers: +<a href="LICENSE"><img src="https://img.shields.io/badge/LICENSE-Apache--2.0-blue.svg" alt="License"></a> + -The primers are available at: +# About: -- https://primer.src.nekernel.org -- https://primer.nectar.nekernel.org +An OS that aims to provide an alternative for backend systems. (Edge Computing, Storage Systems, etc.) made to be easily deployable and forkable as well. -## Love the work? +## Getting Started: -Give us a star on GitHub! +## Building: - +You will need: -## Description: +- `nebuild`, the in-house build system. +- `MinGW` or `Clang`, depending on the HAL/target ISA. +- `CoreUtils`, for the core compiler utilities. -This is the system distribution of Ne.org. +Please follow the the tutorials in `/src/reference` to get started. -Designed the contain all of the stack together. +### Quick Install: -It facilities are provided to build compiler toolchains as well. +```sh +curl -fsSL http://install.nekernel.org | sh +``` -## Getting Started: +### Full installation: Please clone the repository using Git: @@ -40,26 +37,27 @@ git clone --recurse-submodules -j8 git@github.com:ne-foss-org/ne_system.git And have a look at the wiki, docs, and primers. They have valuable resources to get started. -## Rationale: +## Read the primers! + +The primers are available at: + +- https://primer.src.nekernel.org +- https://primer.nectar.nekernel.org + +## Design Rationale: There is three main reasons for this repository's existence: -- Hold the codebase in a single repository. +- Hold the system in a single repository. - 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: +## Packages: -- `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. +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. ## Community: We have a [discord](https://discord.gg/uD76Qweght), join us! [https://discord.gg/uD76Qweght](https://discord.gg/uD76Qweght) -###### Copyright 2025-2026, Amlal El Mahrouss & Ne.org Authors. Licensed under Apache 2.0. +###### Copyright 2025-2026, Amlal El Mahrouss & Ne.org Authors, licensed under Apache 2.0. |