OGV-meteor icon indicating copy to clipboard operation
OGV-meteor copied to clipboard

Published 20 hours ago • verified publisher icon BRL-CAD

Improve readme.

Open inderpreetsingh opened this issue 5 years ago • 4 comments

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

inderpreetsingh avatar Mar 25 '19 14:03 inderpreetsingh

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 avatar Mar 25 '19 15:03 inderpreetsingh

List of awesome readmes

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

inderpreetsingh avatar Mar 25 '19 15:03 inderpreetsingh

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

quentinpaden avatar May 20 '19 23:05 quentinpaden

@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

brlcad avatar May 21 '19 02:05 brlcad