theangryangel/XI4N

Write docs

Closed this issue · 6 comments

No documentation written yet. Needs to cover:

  • Installing
  • Customising config
  • Updating
  • Installing plugins
  • Customising plugins
  • Writing plugins

0dc0860 - Started the API documentation. It's generated from the code comments automatically using Jake.
jake generate-docs

Need to finish code comment docs and also write end user docs.

More API documentation done. Installing and writing plugins todo.

d0f7fb4 requires this all to be re-done.

Platform docs mostly written. API docs need to be done. Pending on #34

Plugin docs need to be written and video needs to be created.

Documentation complete, more or less in e0f333d. Closing this down as a blocker.