Add some docs on building, bumped limine to latest version

No issues occurred having bumped the version, all seems well.
2025-02-22 02:41:23 +00:00
parent 68c3d2fa0e
commit 3aca8fd720
2 changed files with 21 additions and 1 deletions
@@ -1,2 +1,22 @@
 # FoundryOS

+## Cloning and building
+
+Here are some simple steps to get started:
+
+```sh
+# If you have not yet cloned the repo:
+git clone --recurse-submodules https://git.zxq5.dev/OsDev/FoundryOS.git
+# If you already cloned the repo:
+git submodule update --init --recursive
+
+cargo build
+# This will build the binaries if required - no need to call cargo build.
+cargo run
+```
+
+### Build dependencies
+
+* jq: checks whether the app is to be run in debugging mode.
+* libisoburn: creates ISO images to be booted from.
+* qemu: to run the kernel.