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

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.