Readme needs some LUV - Githubissues

gnunicorn / dadada

Artisanal Rust inlined code documentation renderer

15 stars 3 forks source link

Readme needs some LUV #2

Open gnunicorn opened 5 years ago

gnunicorn commented 5 years ago

The readme is very short and barebone at the moment. It should be expanded and explain in more detail. I see the following sections as useful:

Screenshot / example code and example rendering
cargo install-command
how to use / cli params
License section

redoxeon commented 4 years ago

I could help out with this :)

gnunicorn commented 4 years ago

@redoxeon very much welcomed. Yes do the changes and raise a PR!

I am not even certain what I am expected to improve beyond what is said above having additional things said above. Maybe the standard-readme spec has some inspiration :thinking: ?!?

redoxeon commented 4 years ago

oh yeah, the standard-readme spec has some good stuff. I'll add whatever I can and see if I can get a good screenshot added in