From 0941bed42d094e99c577592716a6d618c6f98dff Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Thu, 20 Mar 2025 15:42:54 +0100 Subject: META: Better ReadMe. --- ReadMe.md | 30 +++++++++++++++--------------- 1 file 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. -- cgit v1.2.3