README.md

The Nectar System

Community:

Join us in our Discord, 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
• Git
• Boost (1.90.0+)
• NeBuild
• Doxygen
• GNU CoreUtils
• Git
• OCL.TProc (1.61.0+)

Notice for Contributors:

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

Building:

Run the following:

git clone -j8 git@github.com:ne-foss-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

---

License

This project is licensed under the Apache-2.0 License.

Figures:

Figure 1: The Nectar AMD64 Assembler for NeKernel ABI.

_{© 2023-2026 Amlal El Mahrouss & Ne.org contributors. Licensed under the Apache 2.0 license.}