rust-osdev / rust-osdev/bootloader
Add detailed documentation
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.7k
- Forks
- 240
- PR merge metrics
- No merged PRs in 30d
Description
I want to use this crate to implement an operating system, but I'm confused about the example implementation of the log mentioned in framebuffer.rs.
Could you please add detailed documentation so that it can be easy to use.
Thank you.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with common/src/framebuffer.rs and review the example implementation of the log mentioned in the issue. Document how this example can be used when implementing an operating system with the crate. Done means the framebuffer logging example and its usage are explained in enough detail for a new user to follow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, operating-systems
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100