From bdef578a578177ce95c01fa061a028292556ecbe Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Sat, 29 Nov 2025 14:30:16 -0500 Subject: chore: new README. Signed-off-by: Amlal El Mahrouss --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 716204e..8b1c8a2 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,20 @@
-![CI](https://github.com/amlel-el-mahrouss/cc/actions/workflows/c-cpp.yml/badge.svg) +![CI](https://github.com/amlel-el-mahrouss/cc/actions/workflows/necti.yml/badge.svg) [![License: GPL-3.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) ## Overview: -NeCTI is a modern, multi-platform compiler instractucture designed for modularity, and performance. It features a custom debugger engine, advanced linker, and flexible backend/frontend system. NeCTI is built for research, education, and next-generation toolchain development. +NeCTI is a modern, multi-platform compiler instractucture designed for modularity, and performance. It features a custom debugger engine, advanced linker, and a modular compiler architecture. It is built for research, education, and next-generation toolchain development. ## Structure: -- `dev/CompilerKit` – Compiler Kit written in modern C++ -- `dev/LibC++` – C++ ABI Library -- `dev/LibStdC++` – Standard C++ Library -- `tools/` – Frontend Tools -- `dev/DebuggerKit` – Debugging Kit written in modern C++ +- `src/CompilerKit` – Compiler Kit written in modern C++ +- `src/LibC++` – C++ ABI Library +- `src/LibStdC++` – Standard C++ Library +- `src/DebuggerKit` – Debugging Kit written in modern C++ +- `tools/` – C/C++ Frontend Tools ## Requirements: @@ -27,11 +27,7 @@ NeCTI is a modern, multi-platform compiler instractucture designed for modularit - [Clang](https://clang.llvm.org/) - [Git](https://git-scm.com/) - [NeBuild](https://github.com/nekernel-org/nebuild) - -## Notice for Doxygen: - -- Use doxygen to build documentation. -- You need it installed in order to generate offline documentation! +- [Doxygen](https://www.doxygen.nl/) ## Notice for Contributors: -- cgit v1.2.3