search

ddobrev / QtSharp

Mono/.NET bindings for Qt
Other
571 stars 52 forks source link

Add more structure to the README file. #33

Closed txdv closed 9 years ago

txdv commented 9 years ago

I would recommend for you to use a new line per sentence in README.md because markdown does treat them as if they were in the same line. Also it allows for easier comparison using the diff tools between sentences and what changed in them - when something changes you always only the changed sentence, git also is able to represent what words in that sentence changed. Also, reading it with a simple editor is easier that way ... at least for my taste.

I also added the documentation files in the README, because I feel this should be a resource available immediately when you open the README file.

ddobrev commented 9 years ago

It does look much better now. Thank you very much.