Skip to content

Commit 2e98cbe

Browse files
committed
Update help and Readme
1 parent a1745f8 commit 2e98cbe

File tree

2 files changed

+4
-14
lines changed

2 files changed

+4
-14
lines changed

Readme.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,18 @@ First you need to add a dependency on the `bootloader` crate:
1616
# in your Cargo.toml
1717

1818
[dependencies]
19-
bootloader = "0.2.0-alpha"
19+
bootloader = "0.5.0"
2020
```
2121

22+
**Note**: At least bootloader version `0.5.0` is required.
23+
2224
Now you can build the kernel project and create a bootable disk image from it by running:
2325

2426
```
2527
> bootimage build --target your_custom_target.json [other_args]
2628
```
2729

28-
The command will invoke [`cargo xbuild`](https://github.com/rust-osdev/cargo-xbuild), forwarding all passed options. Then it will download and build a bootloader, by default the [rust-osdev/bootloader](https://github.com/rust-osdev/bootloader). Finally, it combines the kernel and the bootloader into a bootable disk image.
30+
The command will invoke [`cargo xbuild`](https://github.com/rust-osdev/cargo-xbuild), forwarding all passed options. Then it will build the specified bootloader together with the kernel to create a bootable disk image.
2931

3032
## Configuration
3133

@@ -34,15 +36,9 @@ Configuration is done through a through a `[package.metadata.bootimage]` table i
3436
```toml
3537
[package.metadata.bootimage]
3638
default-target = "" # This target is used if no `--target` is passed
37-
output = "bootimage.bin" # The output file name
38-
minimum-image-size = 0 # The minimum output file size (in MiB)
3939
# The command invoked on `bootimage run`
4040
# (the "{}" will be replaced with the path to the bootable disk image)
4141
run-command = ["qemu-system-x86_64", "-drive", "format=raw,file={}"]
42-
43-
[package.metadata.bootimage.bootloader]
44-
name = "bootloader" # The bootloader crate name
45-
target = "x86_64-bootloader.json" # Target triple for compiling the bootloader
4642
```
4743

4844
## License

src/help/build_help.txt

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,3 @@ CONFIGURATION:
1818

1919
[package.metadata.bootimage]
2020
default-target = "" This target is used if no `--target` is passed
21-
output = "bootimage.bin" The output file name
22-
minimum-image-size = 0 The minimum output file size (in MiB)
23-
24-
[package.metadata.bootimage.bootloader]
25-
name = "bootloader" The bootloader crate name
26-
target = "x86_64-bootloader.json" Target triple for compiling the bootloader

0 commit comments

Comments
 (0)