README.md


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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

<!-- Read Me of Nectar -->

<div align="center">
  <h1>
    <b>The Nectar 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>

![CI](https://github.com/nekernel-org/nectar/actions/workflows/nectar-dev.yml/badge.svg)

## Community:

Join us in our [Discord](https://discord.gg/uD76Qweght), we're quite active and open for contributors!

## Getting Started:

### Structure:

- `src/CompilerKit` – Compiler Kit written in C++.
- `include/GenericsLibrary` – Nectar Generics Library.
- `include/CoreRuntimeKit` – Nectar Core Libraries. (C++/Nectar)
- `include/ThirdParty` – Third Party Modules.
- `src/DebuggerKit` – Debugging Kit written in C++.
- `src/CommandLine` – C/Nectar/C++ Command Line Tools.

### Requirements:

- [Clang](https://clang.llvm.org/)
- [Git](https://git-scm.com/)
- [Boost](https://boost.org/)
- [NeBuild](https://github.com/nekernel-org/nebuild)
- [Doxygen](https://www.doxygen.nl/)
- CoreUtils
- [Git](https://git-scm.com/)

### Notice for Contributors:

Always use `format.sh` before commiting and pushing your code!

### Building:

Run the following:

```sh
git clone -j8 git@github.com:nekernel-org/nectar.git
cd nectar
# Either build the debugger or compiler libraries/tools using nebuild.
```

And build the source tree using the NeBuild system.

### Security

- **Vulnerability Disclosure:**  
  Please report security issues privately via email or GitHub Security Advisories.

### Authors & Credits

- **Amlal El Mahrouss** — Lead Developer and Compiler Architect.
- [Full contributor list](https://github.com/nekernel-org/nectar/graphs/contributors)

---

### License

This project is licensed under the [Apache-2.0 License](LICENSE).

### Figures:

#### Figure 1: The Nectar AMD64 Assembler for NeKernel ABI.

<img src="meta/media/pef_amd64_asm.png" alt="Nectar Assembler Assembling" width="1280"/>

<div align="center">
  <sub>
    &copy; 2024-2026 Amlal El Mahrouss & NeKernel contributors. Licensed under the Apache 2.0 license.
  </sub>
</div>