Fix README

This commit is contained in:
River 2025-03-13 00:30:50 -04:00
parent 6829ef55fc
commit 2915a9e746
Signed by: shibedrill
GPG Key ID: 5FE0CB25945EFAA2

View File

@ -41,15 +41,15 @@ Licensed under the GNU Public License v3. See [LICENSE](LICENSE) for details.
## Navigating
- [arch/](src/arch/): Architecture specific features like the display, serial, and interrupts. Each architecture is a subfolder, containing a file or module for each feature.
- [boot.rs](src/boot.rs): Handles bootloader-managed data structures. Gila uses Limine. Other bootloaders are NOT supported.
- [log.rs](src/log.rs): Logging structures and singletons for logging to serial or the display.
- [main.rs](src/main.rs): The entry point that gets called by the bootloader.
- [memory.rs](src/memory.rs): Types relating to memory regions and allocation.
- [panic.rs](src/panic.rs): The panic handler and associated functionality.
- [params.rs](src/params.rs): Kernel parameter handler code.
- [process.rs](src/process.rs): Process types and functions.
- [resources.rs](src/resources.rs): Resources that are accessible from multiple parts of the code.
- [arch/](src/kernelarch/): Architecture specific features like the display, serial, and interrupts. Each architecture is a subfolder, containing a file or module for each feature.
- [boot.rs](src/kernel/boot.rs): Handles bootloader-managed data structures. Gila uses Limine. Other bootloaders are NOT supported.
- [log.rs](src/kernel/log.rs): Logging structures and singletons for logging to serial or the display.
- [main.rs](src/kernel/main.rs): The entry point that gets called by the bootloader.
- [memory.rs](src/kernel/memory.rs): Types relating to memory regions and allocation.
- [panic.rs](src/kernel/panic.rs): The panic handler and associated functionality.
- [params.rs](src/kernel/params.rs): Kernel parameter handler code.
- [process.rs](src/kernel/process.rs): Process types and functions.
- [resources.rs](src/kernel/resources.rs): Resources that are accessible from multiple parts of the code.
## Building and running
@ -68,7 +68,7 @@ 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 binaries, libraries, and ISOs.
- `make gila`: Builds the kernel ELF file.
- `make kernel`: Builds the kernel ELF file.
- `make iso`: Builds the bootable ISO with Limine installed.
- `make run`: Builds the ISO and boots it in QEMU.