summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-03-26 20:35:45 +0100
committerAmlal El Mahrouss <amlal@nekernel.org>2025-03-26 20:35:45 +0100
commit035a530b895bc5341874d4609e168a4eaba6e9c7 (patch)
treecde6e02baa1e4ee2d93fd76ce635c8580c35b569 /README.md
parent733edfd7f7ea2dee27a177127730d04821e313db (diff)
meta: fix and update readmes.
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ef640fe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# NeKernel C/C++
+
+Use the doxygen command to build documentation.
+
+## Notice for Contributors:
+
+- Always use `format.sh` before commiting and pushing your code!
+
+## Requirements:
+
+- [CLang](https://clang.llvm.org/)
+- [GIT](https://git-scm.com/)
+- [BTB](https://github.com/amlel-el-mahrouss/btb)
+
+## Cloning:
+
+```
+git clone git@github.com:amlel-el-mahrouss-gh/cc.git
+```
+
+###### Copyright (C) 2024-2025 Amlal EL Mahrouss, all rights reserved.