search

BRL-CAD / OGV-meteor

Port of BRL-CAD's OGV to meteor
BSD 3-Clause "New" or "Revised" License
16 stars 26 forks source link

Improve readme. #87

Open inderpreetsingh opened 5 years ago

inderpreetsingh commented 5 years ago

The current readme is arguable off-putting to new contributors. We need to do a better job at making the first impression.

inderpreetsingh commented 5 years ago

Some advices on internet about making a good readme https://www.makeareadme.com https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

https://github.com/noffle/art-of-readme

inderpreetsingh commented 5 years ago

List of awesome readmes

https://github.com/matiassingers/awesome-readme

quentinpaden commented 5 years ago

I think I have a really awesome way to improve the readme through lightweight gif formatted recordings embbedded into the documentation.

Where is the best place to talk about future additions? @inderpreetsingh

brlcad commented 5 years ago

@Max2020q For something like the readme, it's probably best to just submit a pull request with your new and improved version and it can be discussed on the pull request. Otherwise, our Zulip chat is a good place to discuss: https://brlcad.zulipchat.com