aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathan Reiner <nathan@nathanreiner.xyz>2023-02-10 14:19:45 +0100
committerNathan Reiner <nathan@nathanreiner.xyz>2023-02-10 14:19:45 +0100
commit6d42a1476ab5dd2893fd5ab8de4b473be120e796 (patch)
treee93e1a1a85d60079fcb289846e6d659a4fbe32ee
parentbd59dd1652787bc3ba330fdf6becba57961626bb (diff)
add deps and qemu description
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
index 02e64ce..0143b56 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,18 @@
# reX - a small operating system
+## Dependencies
+
+- gcc
+- make
+- ar
+- mkisofs
+- isohybrid
+- curl
+- tar
+- qemu (optional)
+
+## Build
+
To build the iso just run
```sh
@@ -16,6 +29,23 @@ More precisely it:
5. Creates an initramfs
6. Creates an iso with ISOLINUX
+## Run in Qemu
+
+To run reX in qemu simply type
+
+```
+$ make qemu
+```
+
+If you want to run it in the nographics mode run
+
+```
+$ make qemu-nographic
+```
+
+> **IMPORTANT** When using nographic use the Serial mode
+> by selecting *Boot reX over serial*
+> in the bootloader.
## Author