rust-osdev / rust-osdev/bootloader
Add detailed documentation
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Rust
- Sterne
- 1.7k
- Forks
- 240
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit common/src/framebuffer.rs und prüfe die im Issue erwähnte Beispielimplementierung des Logs. Dokumentiere, wie dieses Beispiel bei der Implementierung eines Betriebssystems mit dem Crate verwendet werden kann. Als erledigt gilt die Aufgabe, wenn das Beispiel für Framebuffer-Logging und seine Verwendung so ausführlich erklärt sind, dass ein neuer Benutzer ihnen folgen kann.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- rust
- Bereich
- documentation, operating-systems
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100