Clearer README
This commit is contained in:
25
README.md
25
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`
|
||||||
|
|
||||||
```
|
Then, to compile the kernel and make an ISO image file: `make build-iso`
|
||||||
make build-iso
|
To run it with QEMU, `make run`
|
||||||
```
|
|
||||||
|
|
||||||
Then it can be run with `qemu-system-x86_64 kernel.iso`.
|
## Thanks
|
||||||
|
|
||||||
|
PepperOS wouldn't be possible without the following freely-licensed software:
|
||||||
### 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:
|
|
||||||
|
|
||||||
- the [Limine](https://codeberg.org/Limine/Limine) portable bootloader
|
- the [Limine](https://codeberg.org/Limine/Limine) portable bootloader
|
||||||
- Marco Paland's freestanding [printf implementation](https://github.com/mpaland)
|
- Marco Paland's freestanding [printf implementation](https://github.com/mpaland)
|
||||||
|
- the [ZAP](https://www.zap.org.au/projects/console-fonts-zap/) PSF console fonts
|
||||||
Reference in New Issue
Block a user