search

brian-team / brian2genn

Brian 2 frontend to the GeNN simulator
http://brian2genn.readthedocs.io/
GNU General Public License v2.0
47 stars 16 forks source link

Update documentation mentioning development branch #75

Closed JustasB closed 6 years ago

JustasB commented 6 years ago

GeNN install instructions and brian2genn readme reference a development branch, which appears to be no longer available.

When I used 'master' instead of development, I was able to get GeNN and Brian2GeNN to work.

If it should be 'master', I can check in a PR with the updated documentation to both repos.

tnowotny commented 6 years ago

Hi ... well spotted. We changed our development approach slightly a while ago in that the software is developed in the master branch and users are referred to releases for stable versions. In the past we kept the master branch stable between releases and developed in a branch called "development". We must have forgotten to update the docs. if you would like to make a PR we can pull that in. Thanks.

JustasB commented 6 years ago

I checked in a PR for the readme.

For GeNN, I believe the .dox file has already been updated, but the change hasn't been reflected on the genn-team.github.io site. Take a look:

'development' mentioned in here: http://genn-team.github.io/genn/documentation/3/html/Installation.html#GitSnapshot

No mention of development in .dox: https://github.com/genn-team/genn/blob/master/doxygen/01_Installation.dox#L16

tnowotny commented 6 years ago

yep. So we need to refresh the docs on github.io We are in the middle of preparing a release with other substantive changes to the docs so will update when we do the release.

JustasB commented 6 years ago

Ok sounds good. I will close the issue.