I spend a lot of time testing new softwares, and I have to read a lot of README files. But, really often, I find bad repositories, with bad formatted readme. Or worse, no README at all. What the fuck ? How I am supposed to figure out how your code works if you don't give me a fucking clue ?
But, sometimes, I see other big issues on readmes. First, the README.txt files on GitHub. HAVE YOU EVER WATCHED YOUR REPO ? Your shit is not parsed! GitHub only recognizes
.md extension, and it's cool. Markdown is older than GitHub, even than git itself! What's wrong with you ? Why are you using inconsistent file extensions without any style ?
Well, bad file extensions are bad, but not very common. I want to tell you about something really really nastier: fucking
$ in bash command lines, like that:
$ git clone <http://github.com/Kinto/kinto-heroku.git> --depth=1 kinto-instance && cd kinto-instance
$ heroku create && git push heroku master
$ heroku open
What the fuck ? Have you ever used it ? Have you ever tried to copy-paste the lines ? What's wrong with you ? It's dirty and the argument "But with this, you know it's bash command lines" is bullshit. Learn how to use fucking markdown.
```bash THIS means it's bash command lines
$ Not that !
So please, go fix your readme and open pull requests on repositories that do not respect conventions. It's good for you and it saves ponies.