Update and reorganize documentation #315
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicholasbishop
approved these changes
Nov 29, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Coming back to the project after not working on it for a while made me realize that the docs have increased in size as the project grew, yet it's not extremely clear where you need to look to find what. This PR is an attempt to clean up and reorganize them, in order to make them easier to read.
Overview and motivation of the main changes:
The
READMEhas been streamlined to contain only an overview of whatuefi-rsdoes and links to the relevant documentation files.I've also removed the link to gil0mendes' blog post, since at this point it's a bit outdated and no longer matches the current workflow.
The
BUILDING.mdfile has been fleshed out a bit, and I've moved what wasn't common to building and running general UEFI apps to the other files.The
templatedirectory now has aREADMEfile, which contains the description of the template contents. I've also moved the section on "Building kernels which use UEFI" to here, since I think most people who want to build hobby OSes would start from the quick start template.