-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Booting Docs #26
Add Booting Docs #26
Conversation
Would diagrams be out of the question? Not a must-have, but definitely useful for visualizing memory locations and how much memory each section has. We can then adopt additional diagrams when we get to allocating memory in more complex ways! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple of small things, maybe something to keep in mind if we want to standardize docs in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a few small suggestions.
For some reason it seems like single \n
characters are rendering in markdown (when I thought only \n\n
would), stylistically I think it's easier to read as singular paragraphs.
Also, some standards suggestions:
- Registers like
l0
should be put inbackticks
- When referring to the size in bits or bytes, we should use the format:
num-bytes
ornum-bits
: Ex: 32-bit x86 linux
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
|
Ah ok, that makes slightly more sense. I think we should remove those double spaces so it's formatted in paragraphs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good stuff! I think this is ready for merging.
Description
Adds documentation about the booting process
Issue #13
Type of change
Testing
Github's .md renderer likes it.
Checklist: