search

flower-os / flower

A learning OS
https://gitter.im/flower-os/Lobby
Apache License 2.0
53 stars 5 forks source link

External Documentation (I.e not rustdoc) #15

Open Restioson opened 6 years ago

Restioson commented 6 years ago

Should we write a 'book'-escque doc using mdbook? I could host a rendered version.

Restioson commented 6 years ago

Okay, I'm starting to this would be useful for putting miscellaneous information on how to build and run etc. It'd be nicer than doing it all in the readme. On that note we should document the log levels.

Restioson commented 6 years ago

This would be very useful for those wanting to contribute, and ourselves. We could include information on where the heap is set up, how the buddy allocator works, and other information we think is needed. We can evolve this as we fix more bugs and figure out a "what have you tried" list, etc.