From c587f8863b1fd1506d5c485b140389ff0e8e7b14 Mon Sep 17 00:00:00 2001 From: shibedrill Date: Sat, 17 May 2025 12:05:09 -0400 Subject: [PATCH] fix cmdline docs --- Makefile.toml | 2 +- README.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/Makefile.toml b/Makefile.toml index aa834b2..8942a4b 100644 --- a/Makefile.toml +++ b/Makefile.toml @@ -144,4 +144,4 @@ script = ''' [tasks.run] dependencies = ["iso"] command = "${QEMUCOMMAND}" -args = ["-display", "none", "-drive", "file=build/gila.iso,format=raw,index=0,media=disk", "-serial", "stdio"] \ No newline at end of file +args = ["-drive", "file=build/gila.iso,format=raw,index=0,media=disk", "-serial", "stdio"] \ No newline at end of file diff --git a/README.md b/README.md index c3cdcbc..04b811b 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,8 @@ Licensed under the GNU Public License v3. See [LICENSE](LICENSE) for details. ## Building and running -Building a bootable kernel is easy. All you need to do is run `cargo build --bin kernel`, and a valid, bootable Limine executable will be generated. However, it cannot be booted without installing it in a bootable Limine filesystem. +Building a bootable kernel is easy. All you need to do is run `cargo build --bin kernel`, and a valid, bootable Limine executable will be generated. However, it cannot be booted without installing it in a bootable Limine filesystem, and it cannot do anything useful without an initramfs containing system servers such as the init server and +device drivers. This project uses [cargo-make](https://github.com/sagiegurari/cargo-make) to handle building ISOs and managing files not associated with Cargo. You need to install it before you can build an ISO automatically. To do so, you can run `cargo install cargo-make`. In addition, you will also need: @@ -101,10 +102,11 @@ List of current extant kernel parameters: - `-loglevel`: Can be a number or string corresponding to a log level. Only one value supported. - `-logdev`: A sequence of one or more values representing devices to log to. Current options are `display` and `serial`. +- `-initramfs`: A valid path to a module to serve as the initramfs (containing the init binary). Only one value supported. The default `cmdline` is: -`-loglevel=INFO -logdev=display,serial` +`-loglevel=INFO -logdev=display,serial -initramfs=/boot/initramfs.tar.lzma` ## Credits