summaryrefslogtreecommitdiffhomepage
path: root/README.md
blob: 0ac2a3d48236ef44a360e36b6d0a2e0cf3e4682a (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
<!-- Read Me of NeKernel Sources -->

<div align="center">
  <h1>
    <b>The NeKernel.org.</b>
  </h1>
  <p>
    <a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache--2.0-blue.svg" alt="License"></a>
  </p>
</div>

## Abstract:

This is the software distribution of NeKernel.org. Designed the contain all of the stack together. Facilities are provided to build compiler toolchains as well.

## Getting Started:

Please clone the repository using Git:

```sh
git clone --recurse-submodules -j8 git@github.com:nekernel-org/src.git
```

And 

## Rationale:

There is three main reasons for this repository's existence:

- Hold the codebase in a single repository.
- Easier path resolutions based on a virtual root path, i.e (../kernel -> /src/kernel)
- Easier cycles and vetting for NeKernel.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.

###### Copyright 2025, Amlal El Mahrouss & NeKernel.org Authors. Licensed under Apache 2.0.