summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-03-31 16:51:51 +0200
committerAmlal El Mahrouss <amlal@nekernel.org>2025-03-31 16:51:51 +0200
commitc87132386b4718b4cda036b17caec988dbb2069f (patch)
tree03e31716cc265902241ff43ccad7c269182bbd60 /README.md
parentd62606e83241d1377790c5e69b988c805523fa51 (diff)
meta: update readme, made it clearer.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index f3d7b5d9..a6e4ed95 100644
--- a/README.md
+++ b/README.md
@@ -23,18 +23,18 @@ A documentation regarding building, and developing for NeKernel is available her
## Notice for Contributors:
-- You must mount the contents to the nekernel-esp.img prior running! Otherwise the emulator won't find a valid ESP.
-- Always use `format.sh` before commiting and pushing your code!
+- You must mount the contents to the nekernel-esp.img prior running!
+ - It depends mostly on how your platform manages them, so have a look at it.
-## Quick Install:
+- Run `format.sh` before commiting, it formats the code according to the .clang-format.
-Clone the repository:
+## Getting Started:
```sh
git clone git@github.com:amlel-el-mahrouss/nekernel.git
cd nekernel
./setup_amd64.sh
-./debug_ata.sh # Generic ATA PIO target
+./debug_ata_x64.sh # Generic ATA PIO target
```
###### Copyright (C) 2024-2025 Amlal El Mahrouss, All rights reserved.