Improve contributors' guide for newcomers (new developers)

dasher-project / dasher

Dasher

http://www.inference.phy.cam.ac.uk/dasher/

GNU General Public License v2.0

154 stars 45 forks source link

Improve contributors' guide for newcomers (new developers) #127

Open cagdasgerede opened 6 years ago

cagdasgerede commented 6 years ago

Revise README pages for each platform (This issue can be divided into a separate issue for each platform) so that newcomers have better idea on how to set things up and how they can contribute.

willwade commented 6 years ago

ha. Re: #128

cagdasgerede commented 6 years ago

@willwade I meant this for new developers. But certainly it can also be improved for new users. I think that is what you meant, right?

willwade commented 6 years ago

@cagdasgerede Interesting. I was thinking of Users, AAC professionals & communication partners predominately. The developers' readmes need to be a bit focused on the coding env and structure of dasher I guess for each repo.

willwade commented 6 years ago

See something like this: http://www.chartjs.org/docs/latest/getting-started/ - its made using GitBook.com - with the raw help files managed in the repo like this: https://github.com/chartjs/Chart.js/tree/master/docs

Tinkering with the website and I'm thinking of sending users directly to the Getting started section of this kind of documentation and keeping the site really slim (We can then do a Developers chapter too). Not sure what others think?