Readmes
Some suggestions for what we should document in the Readme file:
-
Root Readme.md -
Project Overview -
Directory layout -
Where are the tests and demos -
Overview of tests and demos -
How to run the tests and demos on hardware and simulator -
How to include RISC5-FreeRTOS port in a project -
How to include drivers in a project -
Limitations of the RISC5-FreeRTOS port (e.g. no nested interrupt support) -
In depth explanation of how a FreeRTOS port and the RISC5 port specifically works
-
- Do we need additional readmes in subdirectories?
- Link to mni chat?
Edited by Jan Merle