From b1b4bd02219ac9dffc16ebe34cf134a3d80b6da9 Mon Sep 17 00:00:00 2001 From: xamidev Date: Sun, 21 Dec 2025 15:39:55 +0100 Subject: [PATCH] Clearer README --- README.md | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 18a5428..60fb593 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,16 @@ -# pepperOS +# pepperOS: "will never be done" -will never be done +## Trying the kernel -To compile the kernel and make an ISO image file: +First install the dependencies: `sudo apt install xorriso make qemu-system` -``` -make build-iso -``` +Then, to compile the kernel and make an ISO image file: `make build-iso` +To run it with QEMU, `make run` -Then it can be run with `qemu-system-x86_64 kernel.iso`. +## Thanks - -### Kernel conventions - -Functions that return an integer as status of success/failure will return: -- 0 if everything went correctly -- a negative value if something went wrong - -### Thanks - -PepperOS wouldn't be possible without: +PepperOS wouldn't be possible without the following freely-licensed software: - the [Limine](https://codeberg.org/Limine/Limine) portable bootloader - Marco Paland's freestanding [printf implementation](https://github.com/mpaland) +- the [ZAP](https://www.zap.org.au/projects/console-fonts-zap/) PSF console fonts \ No newline at end of file