Skip to content

Commit 5aa11af

Browse files
authored
Merge pull request #519 from nicholasbishop/bishop-add-book-readme
Update documentation section of readme
2 parents 6b6e58c + ad6f078 commit 5aa11af

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,18 @@ This project contains multiple sub-crates:
5353

5454
## Documentation
5555

56-
The docs for the latest published crate version can be found at
57-
[docs.rs/uefi/](https://docs.rs/uefi/)
56+
The [uefi-rs book] contains a tutorial, how-tos, and overviews of some
57+
important UEFI concepts.
5858

59-
This crate's documentation is fairly minimal, and you are encouraged to refer to
60-
the [UEFI specification][spec] for detailed information.
59+
Reference documentation can be found on docs.rs:
60+
- [docs.rs/uefi](https://docs.rs/uefi)
61+
- [docs.rs/uefi-macros](https://docs.rs/uefi-macros)
62+
- [docs.rs/uefi-services](https://docs.rs/uefi-services)
63+
64+
For additional information, refer to the [UEFI specification][spec].
6165

6266
[spec]: http://www.uefi.org/specifications
67+
[uefi-rs book]: https://rust-osdev.github.io/uefi-rs/HEAD
6368

6469
## Building and testing uefi-rs
6570

0 commit comments

Comments
 (0)