summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-07-21 14:52:47 +0100
committerAmlal El Mahrouss <amlal@nekernel.org>2025-07-21 14:52:47 +0100
commit29cdd455ebe5ea61481c47a35f7d621075795cc0 (patch)
tree9731e26d8baf6bbb7ba1149bb8698b3404e0499b /README.md
parentd978aea4025338d2cabd61c050d879b6db3ec199 (diff)
feat: reintroduce PowerPC, ARM, and Open64x0 C compiler frontends.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 18 insertions, 4 deletions
diff --git a/README.md b/README.md
index 4ba0f3d..3ede01e 100644
--- a/README.md
+++ b/README.md
@@ -9,15 +9,29 @@
![CI](https://github.com/amlel-el-mahrouss/cc/actions/workflows/c-cpp.yml/badge.svg)
[![License: GPL-3.0](https://img.shields.io/badge/license-GPL--3.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 OS development.
+
+## Structure:
+
+- `dev/LibCompiler` – Compiler Infrastructure Framework written in modern C++
+- `dev/LibC++` – C++ ABI Library
+- `dev/LibStdC++` – Standard C++ Library
+- `tools/` – Frontend Tools
+- `dev/LibDebugger` – Debugging Library written in modern C++
+
+
## Requirements:
- [Clang](https://clang.llvm.org/)
-- [GIT](https://git-scm.com/)
+- [Git](https://git-scm.com/)
- [NeBuild](https://github.com/nekernel-org/nebuild)
## Notice for Doxygen:
-- Use the doxygen command to build documentation.
+- Use doxygen to build documentation.
+- You need it installed in order to generate offline documentation!
## Notice for Contributors:
@@ -26,8 +40,8 @@
## Getting Started:
```sh
-git clone git@github.com:nekernel-org/ncti.git
-cd ncti
+git clone git@github.com:nekernel-org/necti.git
+cd necti
# Either build debugger or compiler libraries/tools using nebuild.
```