-
-
Notifications
You must be signed in to change notification settings - Fork 180
Description
I've started working on some new documentation for uefi-rs, rendered with mdBook.
Here's the rendered WIP book showing what I have so far:
https://nicholasbishop.github.io/uefi-rs
This is intended to complement the crate documentation on docs.rs, helping to fill in some of the gaps between that documentation and the UEFI Specification. Here's roughly what I hope to cover for starters:
- A simple tutorial to walk through the steps needed to create, build, and run a "hello world" application.
- Walkthroughs for things like opening protocols, reading files, and displaying graphics.
- Explanations of important UEFI concepts. The specification is of course the canonical source of information, but it can make for pretty dense reading so I think we can compliment it with some high-level overviews.
Related to this I want to add more standalone examples to the test runner. These can then be included by mdBook
, which has special syntax for showing parts of a file so that individual parts can be explained.
I'm not quite ready to put up a PR yet, and it might end up being split over a few PRs anyway so figure'd I'd go ahead and make an issue to track the work.
Feedback welcome!