Tutorial and improved introductory documentation...

[mossblaser]

• Adds a new hello world to circuit sim tutorial
• Moves other existing tutorials alongside it in a list at the top of the documentation page
• Adds a random collection of <10 line Rig examples. Feel free to contribute to these!
• Adds a silly example in the "quick start" section of the main README since it seemed silly to only install rig as a "quick start"...
• Propose removing the tutorial from rig examples (and probably closing the repository) and perhaps moving the heat demo example somewhere else...

Comments, suggestions etc. are warmly welcomed!

I've set up RTD to build the documentation for this branch. It can be found here: http://rig.readthedocs.io/en/tutorial/

[mundya]

Propose removing the tutorial from rig examples (and probably closing the repository) and perhaps moving the heat demo example somewhere else...

I'm good with this, we could ask GitHub support to redirect the closed repo to the tutorials at ReadTheDocs.

[mundya]

I think the tutorial is good excellent, though I think the ramp up to specifying custom routing tables might be a bit fast or needs a pointer to something explaining TCAMs/the router.

[mundya]

Note spelling of "separation" in place_and_route.png, and "fault tolerant"

[mossblaser]

I'm good with this, we could ask GitHub support to redirect the closed repo to the tutorials at ReadTheDocs.

Do github do that sort of thing?

An alternative is to leave the repo there but set the "default" branch to one which just contains a README pointing to the new docs and similarly update the RTD for rig_examples.

I think the ramp up to specifying custom routing tables might be a bit fast or needs a pointer to something explaining TCAMs/the router.

You're certainly right though my initial hope was to avoid writing a SpiNNaker tutorial as much as possible. Perhaps a note referring to the appropriate part of the datasheet (which I seem to remember was actually not a bad introduction to the MC table stuff) and a comment to the effect of "if you're interested in what this does, read the datasheet, if you're not, in the next part we'll automate this: this part is mostly a straw-man...).

With all that said, you fancy writing a quick primer I'd be absolutely delighted to include it! (I'm just lazy!)

[mossblaser]

_RAAAAGEEE_

[mundya]

I'm good with this, we could ask GitHub support to redirect the closed repo to the tutorials at ReadTheDocs.

Do github do that sort of thing?

Yep :) e.g., https://github.com/ctn-waterloo/nengo_spinnaker used to point elsewhere.

You're certainly right though my initial hope was to avoid writing a SpiNNaker tutorial as much as possible. Perhaps a note referring to the appropriate part of the datasheet (which I seem to remember was actually not a bad introduction to the MC table stuff) and a comment to the effect of "if you're interested in what this does, read the datasheet, if you're not, in the next part we'll automate this: this part is mostly a straw-man...).

That sounds like enough! Totally understand not wanting to write a SpiNNaker tutorial.

[mundya]

That all looks good to me...