README.md

@@ -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.

scripts/run.sh

@@ -85,7 +85,7 @@ mkdir -p "$iso_root/EFI/BOOT"
 if [ ! -d "$build_dir/limine" ]; then
     compiling "limine bootloader"
     cd "$build_dir"
-    git clone https://github.com/limine-bootloader/limine.git --branch=v8.x-binary --depth=1 "$build_dir/limine" || error "failed to clone limine"
+    git clone https://github.com/limine-bootloader/limine.git --branch=v9.x-binary --depth=1 "$build_dir/limine" || error "failed to clone limine"
     make -C "$build_dir/limine" || error "failed to build limine"
     cd "$project_root"
 fi