summaryrefslogtreecommitdiffhomepage
path: root/README.md
blob: eb2dc149a82cc2a3e894fde6a42d3fe40e07c1d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<!-- Read Me of NeKernel Sources -->

# 🍯 The NeSystem

<a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache--2.0-blue.svg" alt="License"></a>
![GitHub Repo stars](https://img.shields.io/github/stars/ne-foss-org/ne-system)

# 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
```

### Full installation:

Please clone the repository using Git:

```sh
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.

## 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 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.

## 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.

## 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.