summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-07-31 08:59:06 +0100
committerAmlal El Mahrouss <amlal@nekernel.org>2025-07-31 08:59:06 +0100
commitb21d8393b50009b7b378733f07d50dc76c33784e (patch)
treeef3f83376df395a850b2139da098f546037a4c6b /README.md
parent1891d7343a9ac25ab157c4495581a0fcbd7fbcbf (diff)
feat: add CODEOWNERS and update readme.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0ac4b47
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# NeBoot
+
+![ARM64](https://github.com/nekernel-org/neboot/actions/workflows/arm64.yml/badge.svg)
+[![License: GPL-3.0](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](LICENSE)
+[![QEMU Tested](https://img.shields.io/badge/QEMU-Tested-success)](#)
+
+# Brief
+
+NeBoot is a cross-platform open implementation of a firmware written in C, designed with modularity and portability in mind.
+
+## Notice for Doxygen:
+
+Build the documentation using Doxygen's `doxygen` CLI tool.
+
+## Requirements:
+
+- [Clang](https://clang.llvm.org/)
+- [NASM](https://nasm.us/)
+- [Git](https://git-scm.com/)
+- GNU Developer Utils (Make, GCC...)
+
+## Cloning:
+
+```sh
+ git clone git@github.com:nekernel-org/neboot.git
+ cd neboot
+```
+
+###### Copyright 2024-2025, Amlal El Mahrouss and NeKernel.org Contributors, all rights reserved.