xchoo / spaun2.0

Spaun (nengo 2.0 version)
63 stars 27 forks source link

Add documentation #10

Open tbekolay opened 7 years ago

tbekolay commented 7 years ago

This includes a page with Spaun videos, and the list of popular press articles, both of which are ported from nengo.ca.

In the future, we can flesh this out with API docs, command line usage, and more. But for now, it's worth having so that we can point people to this page in lieu of having this content on nengo.ca.

Note that this includes a .travis.yml, which can be used to build the documentation. Two things have to happen for this to work: enable this project on TravisCI, and to make a security token that TravisCI can use to push to this repository.

@xchoo, if you want to do this stuff now, hit me up on Slack, but it doesn't actually have to happen right now as I've also pushed the gh-pages branch that TravisCI would create, so the documentation is already rendered properly at http://xchoo.github.io/spaun2.0/. I don't think these docs will change anytime soon, so we can deal with the TravisCI stuff when we figure out where this repo will live long-term.