summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-12-07 09:16:13 -0500
committerGitHub <noreply@github.com>2025-12-07 09:16:13 -0500
commit04262d4fa5ee1eb9a02590291e34d94325e16318 (patch)
treeabc22a70cd51c3afddd6d1e5fc2c8c2da6cf1407
parentc282b4b1326aa38a833d53de74e6b489d94fe92e (diff)
parent3129aa45dfb7118de108d9a94c04b8eb9c0d4120 (diff)
Merge pull request #14 from nekernel-org/new-readme
chore: new README.
-rw-r--r--README.md19
1 files changed, 9 insertions, 10 deletions
diff --git a/README.md b/README.md
index acdb3ba..a5dd08d 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,12 @@
# 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)](#)
+[![License: GPL-3.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
-# Brief
+## Abstract
NeBoot is a cross-platform open implementation of the EPM 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/)
@@ -19,11 +14,15 @@ Build the documentation using Doxygen's `doxygen` CLI tool.
- [Git](https://git-scm.com/)
- GNU Developer Utils (Make, GCC...)
-## Cloning:
+## Contributing:
+
+Please fork, and clone the repository.
```sh
- git clone git@github.com:nekernel-org/neboot.git
+ git clone git@github.com:<your-username>/neboot.git
cd neboot
```
-###### Copyright 2024-2025, Amlal El Mahrouss and NeKernel.org Contributors, licensed under Apache 2.0.
+And then contribute back your changes to `develop`.
+
+###### Copyright 2024-2025, Amlal El Mahrouss and NeKernel.org Authors, licensed under Apache 2.0.