Skip to content

Commit eccb89d

Browse files
committed
Document the created disk images
1 parent 2058af6 commit eccb89d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/lib.rs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,22 @@ but does not create any bootable disk images. To create them, two additional ste
4040
images should be placed. It is recommended to set `--target-dir` to the `target` folder of your
4141
kernel and `--out-dir` to the the parent folder of `--kernel-binary`.
4242
43+
This will result in the following files, which are placed in the specified `--out-dir`:
44+
45+
- A disk image suitable for BIOS booting, named `boot-bios-<kernel>.img`, where `<kernel>` is the
46+
name of your kernel executable. This image can be started in QEMU or booted on a real machine
47+
after burning it to an USB stick..
48+
- A disk image suitable for UEFI booting, named `boot-uefi-<kernel>.img`. Like the BIOS disk image,
49+
this can be started in QEMU (requires OVMF) and burned to an USB stick to run it on a real
50+
machine.
51+
- Intermediate UEFI files
52+
- A FAT partition image named `boot-uefi-<kernel>.fat`, which can be directly started in QEMU
53+
or written as an EFI system partition to a GPT-formatted disk.
54+
- An EFI file named `boot-uefi-<kernel>.efi`. This executable is the combination of the
55+
bootloader and kernel executables. It can be started in QEMU or used to construct a bootable
56+
disk image: Create an EFI system partition formatted with the FAT filesystem and place the
57+
EFI file under `efi\boot\bootx64.efi` on that filesystem.
58+
4359
## Configuration
4460
4561
The bootloader can be configured through a `[package.metadata.bootloader]` table in the

0 commit comments

Comments
 (0)