summaryrefslogtreecommitdiffhomepage
path: root/ReadMe.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal.elmahrouss@icloud.com>2025-03-20 15:42:54 +0100
committerAmlal El Mahrouss <amlal.elmahrouss@icloud.com>2025-03-20 15:42:54 +0100
commit0941bed42d094e99c577592716a6d618c6f98dff (patch)
treedff4bd384ee9cf01fdec80641c71a0690516dc5d /ReadMe.md
parentb3795cedd8f6409f52157f34e9acc8af9143e320 (diff)
META: Better ReadMe.
Diffstat (limited to 'ReadMe.md')
-rw-r--r--ReadMe.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/ReadMe.md b/ReadMe.md
index 1f0554bc..76b0a536 100644
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -2,31 +2,31 @@
# NeKernel
+## Required:
+- [MINGW-W64](https://www.mingw-w64.org/)
+- [CLANG](https://clang.llvm.org/)
+- [NASM](https://nasm.us/)
+- [GIT](https://git-scm.com/)
+- [BTB](https://github.com/ne-gh/btb)
-## Required:
+## Building's Notice:
+
+You have to mount the FAT32 image in order to put the src/Root/ contents in it! (To make the emulator boot NeOS)
+
+## Contributors's Notice:
-- MinGW/GCC, Clang.
-- Netwide Assembler.
-- Git.
-- BTB.
+Always use `run_format.sh` before commiting and pushing your code!
-## Install:
+## Quick Install:
-Clone repository:
+Clone the repository:
```sh
git clone git@github.com:ne-gh/kernel.git
cd kernel
+./setup_amd64.sh
./debug_ata.sh # Generic ATA PIO target
```
-## Good first PRs:
-
-- Contribute to the AHCI generic driver, it's the current main effort to bring modern storage standards to the kernel.
-
-## Warning:
-
-You have to mount the FAT32 image in order to put the src/Root/ contents in it! (To make the emulator boot NeOS)
-
###### Copyright (C) 2024-2025 Amlal EL Mahrouss, All rights reserved.