Skip to content

What your tutorial should be

james tichenor edited this page Jun 14, 2018 · 12 revisions

What

Each group is writing a tutorial that will clearly explain how to make your project and get people excited about doing it themselves.

How

Your tutorial will be a github wiki page and should include anything someone would need to build your project including:

  • Step by step instructions
  • Code snippets
  • System Diagram of your project
  • Unity assets needs
  • Diagram or photos of your wiring and circuit

Each project documentation needs at least 3 gifs. Each gif should be exactly 1080px x 1080px

  • gif showing physical interaction with the RPI
  • gif showing vistual interaction with Unity
  • Hero gif explaining the project.

additional images, gifs, video or other media are up to you.

notes on how to edit a Github wiki page

Examples

These examples from the Spacebrew page show the level of detail and tone we are looking for from these tutorials:

  1. http://docs.spacebrew.cc/tutorials/2012/11/21/connecting-a-sparkfun-kit-to-spacebrew
  2. http://docs.spacebrew.cc/tutorials/2013/2/6/power-switch-tail-contorl-any-ac-electrical-device-remotely-via-spacebrew
  3. http://docs.spacebrew.cc/tutorials/2013/1/31/heres-clawdia-the-robotic-servo-controlled-claw
Clone this wiki locally