summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-12-02 15:47:44 -0500
committerAmlal El Mahrouss <amlal@nekernel.org>2025-12-02 15:49:18 -0500
commitbcc6100941117dc84fb9ece3812da340d96c61a6 (patch)
treed27a97e5a4a8cfa6bfdb3688c2be0183f69e3fbd /README.md
parentf7930b3a1279922cf9e6e75e651fe9b5df247bc6 (diff)
chore! reworked source code to exclude `Bool`, `Boolean`, and `nullPtr` macros.
fix: ErrorOr: Return `Ref<T>&` when using Leak. Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index 218c38e..0dfc1f9 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@ NeCTI is a modern, multi-platform compiler instractucture designed for modularit
- `src/LibC++` – C++ ABI Library
- `src/LibStdC++` – Standard C++ Library
- `src/DebuggerKit` – Debugging Kit written in modern C++
-- `tools/` – C/C++ Frontend Tools
+- `src/Tools/` – C/C++ Frontend Tools
## Requirements:
@@ -32,16 +32,20 @@ NeCTI is a modern, multi-platform compiler instractucture designed for modularit
## Notice for Contributors:
-- Always use `format.sh` before commiting and pushing your code!
+Always use `format.sh` before commiting and pushing your code!
## Getting Started:
+Run the following:
+
```sh
git clone git@github.com:nekernel-org/necti.git
cd necti
# Either build the debugger or compiler libraries/tools using nebuild.
```
+And build the source tree using the NeBuild system.
+
## Security
- **Vulnerability Disclosure:**