Skip to content

Commit 824b33a

Browse files
committed
multiboot2-common: doc improvement with figures
1 parent aadcf8b commit 824b33a

6 files changed

+385
-7
lines changed

multiboot2-common/README.md

+17
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,23 @@
55

66
Common helpers for the `multiboot2` and `multiboot2-header` crates.
77

8+
## Architecture
9+
10+
The following figures, not displayable in `lib.rs` / on `docs.rs` unfortunately,
11+
outline the design of this crate:
12+
13+
![Overview Multiboot2 Structures](./overview-multiboot2-structures.drawio.png "Overview Multiboot2 Structures")
14+
15+
Overview of Multiboot2 structures: Multiboot2 boot informations, boot
16+
information tags, Multiboot2 headers, and Multiboot2 header tags all share the
17+
same technical foundation: They have a common header and a possible dynamic
18+
size, depending on the header.
19+
20+
![Crate Architecture Overview](./architecture.drawio.png "Crate Architecture Overview")
21+
22+
Overview of how raw bytes are modelled to be representable by high-level rusty
23+
types.
24+
825
## MSRV
926

1027
The MSRV is 1.70.0 stable.
175 KB
Loading

0 commit comments

Comments
 (0)