Skip to content
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 detailed documentation #488

Open
Hello-world150 opened this issue Jan 23, 2025 · 1 comment
Open

Add detailed documentation #488

Hello-world150 opened this issue Jan 23, 2025 · 1 comment

Comments

@Hello-world150
Copy link

Hello-world150 commented Jan 23, 2025

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.

@Freax13
Copy link
Member

Freax13 commented Jan 23, 2025

Please read https://github.com/rust-osdev/bootloader?tab=readme-ov-file#usage. I don't think framebuffer.rs is meant to be used as an example for a logging implementation, it's primarily meant to be the logging implementation used by the bootloader. If you can use it for inspiration that's great, but its primary purpose is not education.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants