-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Documentation
Sue Lockwood edited this page Jan 27, 2015
·
2 revisions
Just write the damn docs.
When writing documentation be sure to at least include the following:
- Working annotated example code for all supported hardware
- A breadboard diagram to go with each code example
- Documentation for each class parameter
Annotated example code goes in the eg/ folder, breadboard images are located in docs/breadboard and the docs markdown files are generated using the grunt task: grunt examples
see task here