diff --git a/README.md b/README.md index 552bf80978b7ef0527953c7ebf9dce16c4164e8d..8562a4b1582f338404d9d33abee8b8c0726016e0 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,37 @@ Idk, I asked ChatGPT to give it a name: > shape of Hyperion and its rapid rotation could be seen as metaphors for the flexibility and speed > of a modern operating system. +## How do I run it? + +### In QEMU + +It is as simple as just: + +```bash +make run +``` + +### On HW? + +Please don't + +## Dependencies + +Packages for Arch: +```bash +pacman -Syu make qemu-system-x86 xorriso jq +``` + +Rust: +```bash +# rustup: +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh +# bare metal target +rustup target add x86_64-unknown-none +# nightly compiler +rustup toolchain install nightly +``` + ## Demo image(s) 