Skip to content

Commit c2288e6

Browse files
committed
Updated README description of the crate
1 parent eb3be22 commit c2288e6

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@
33
[![crates.io](https://img.shields.io/crates/v/multiboot2.svg)](https://crates.io/crates/multiboot2)
44
[![docs](https://docs.rs/multiboot2/badge.svg)](https://docs.rs/multiboot2/)
55

6-
An experimental Multiboot 2 crate for ELF-64 kernels. It's still incomplete, so please open an issue if you're missing some functionality. Contributions welcome!
6+
Library that helps you to parse the multiboot information structure (mbi) from
7+
Multiboot2-compliant bootloaders, like GRUB. It supports all tags from the specification
8+
including full support for the sections of ELF-64. This library is `no_std` and can be
9+
used in a Multiboot2-kernel.
710

8-
It uses the Multiboot 2.0 specification at https://www.gnu.org/software/grub/manual/multiboot2/multiboot.html and the ELF 64 specification at http://www.uclibc.org/docs/elf-64-gen.pdf.
11+
It follows the Multiboot 2.0 specification at https://www.gnu.org/software/grub/manual/multiboot2/multiboot.html and the ELF 64 specification at http://www.uclibc.org/docs/elf-64-gen.pdf.
912

1013
Below is the draft for a blog post about this. I don't plan to finish it but maybe it's helpful as documentation.
1114

0 commit comments

Comments
 (0)