diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 19 insertions, 25 deletions
@@ -1,23 +1,33 @@ <!-- Read Me of NeKernel Sources --> -<div align="center"> - <h1> - <b>🍯 The NeSystem:</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 + +<a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache--2.0-blue.svg" alt="License"></a> + + +# About: + +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. ## 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! - - - ## 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. |