feat!: update the kernel codegen to output bit width and origin.

refactor!: refactor codebase, breaking changes.

Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>

1 files changed, 18 insertions, 10 deletions

diff --git a/README.md b/README.md
index 97a5750..b76a345 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,21 @@
-# NeKernel C/C++
+<!-- Read Me of NeKernel C++ -->
+
+<div align="center">
+  <img src="meta/png/nekernel.png" alt="Logo" width="256"/>
+</div>
+
+<br/>
 
 ![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)
 
-## Notice for Documentation:
+## Requirements:
+
+- [CLang](https://clang.llvm.org/)
+- [GIT](https://git-scm.com/)
+- [BTB](https://github.com/nekernel-org/btb)
+
+## Notice for Doxygen:
 
 - Use the doxygen command to build documentation.
 
@@ -11,16 +23,12 @@
 
 - Always use `format.sh` before commiting and pushing your code!
 
-## Requirements:
+## Getting Started:
 
-- [CLang](https://clang.llvm.org/)
-- [GIT](https://git-scm.com/)
-- [BTB](https://github.com/nekernel-org/btb)
-
-## Cloning:
-
-```
+```sh
 git clone git@github.com:nekernel-org/cc.git
+cd cc
+# Either build debugger or compiler using btb
 ```
 
 ###### Copyright (C) 2024-2025 Amlal El Mahrouss, all rights reserved.