From a243f98e632eefc85565af7da4c65b66e9595dfa Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Sun, 22 Feb 2026 13:46:43 +0100 Subject: chore: reworking README. Signed-off-by: Amlal El Mahrouss --- README.md | 33 +++++++++++++++++++++++---------- meta/media/pef_amd64_asm.png | Bin 0 -> 35345 bytes 2 files changed, 23 insertions(+), 10 deletions(-) create mode 100644 meta/media/pef_amd64_asm.png diff --git a/README.md b/README.md index 63501de..d01710f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,20 @@ -# The Nectar System. - -## Status: +
+

+ The NeKernel System +

+

+ License +

+
![CI](https://github.com/nekernel-org/nectar/actions/workflows/nectar-dev.yml/badge.svg) [![License: GPL-3.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) -## Structure: +## Getting Started: + +### Structure: - `src/CompilerKit` – Compiler Kit written in C++. - `include/GenericsLibrary` – Nectar Generics Library. @@ -16,7 +23,7 @@ - `src/DebuggerKit` – Debugging Kit written in C++. - `src/CommandLine` – C/Nectar/C++ Command Line Tools. -## Requirements: +### Requirements: - [Clang](https://clang.llvm.org/) - [Git](https://git-scm.com/) @@ -26,11 +33,11 @@ - CoreUtils - [Git](https://git-scm.com/) -## Notice for Contributors: +### Notice for Contributors: Always use `format.sh` before commiting and pushing your code! -## Getting Started: +### Building: Run the following: @@ -42,19 +49,25 @@ cd nectar And build the source tree using the NeBuild system. -## Security +### Security - **Vulnerability Disclosure:** Please report security issues privately via email or GitHub Security Advisories. -## Authors & Credits +### Authors & Credits - **Amlal El Mahrouss** — Lead Developer and Compiler Architect. - [Full contributor list](https://github.com/nekernel-org/nectar/graphs/contributors) --- -## License +### Figures: + +#### Figure 1: The Nectar AMD64 Assembler for NeKernel ABI. + +Nectar Assembler Assembling + +### License This project is licensed under the [Apache-2.0 License](LICENSE). diff --git a/meta/media/pef_amd64_asm.png b/meta/media/pef_amd64_asm.png new file mode 100644 index 0000000..da9a814 Binary files /dev/null and b/meta/media/pef_amd64_asm.png differ -- cgit v1.2.3