Fix README

This commit is contained in:
River 2025-03-05 23:05:38 -05:00
parent e432b5a48e
commit 89f21f577d
Signed by: shibedrill
GPG Key ID: 5FE0CB25945EFAA2

View File

@ -65,14 +65,17 @@ To build an ISO image that you can boot, there are several prerequisites:
Then run `make` to invoke the [Makefile](Makefile).
- `make checkenv`: Asserts all needed commands and resources are accessible.
- `make prepare`: Installs needed Rust toolchain.
- `make clean`: Cleans all built files.
- `make clean`: Cleans all built binaries, libraries, and ISOs.
- `make gila`: Builds the kernel ELF file.
- `make iso`: Builds the bootable ISO with Limine installed.
- `make run`: Builds the ISO and boots it in QEMU.
By supplying `TARGET=(rustc target triple)` as an additional argument, you can change the architecture that gila will be compiled & run for. The default is `x86_64-unknown-none`.
The default limine BIOS file search directory is `/usr/share/limine`. You can change this by supplying a path (no trailing slash) like so: `LIMINE-DIR=/home/user/Downloads/limine`.
You can install all these dependencies automatically by using `nix-shell` and
supplying [shell.nix](shell.nix) as an argument.