Awesome-Mirrors/awesome-readme
1
0
Fork 0
mirror of https://github.com/matiassingers/awesome-readme.git synced 2024-12-25 15:19:31 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add articles about writing a great readme

Browse Source
This commit is contained in:
Matias Singers 2015-01-19 14:31:33 +08:00
parent 813b43a325
commit c6200a7d59
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
readme.md
View File

@ -5,12 +5,20 @@ Inspired by the [awesome](https://github.com/sindresorhus/awesome) list thing.
Elements in beautiful READMEs include, but not limited to: images, screenshots, GIFs, text formatting, etc. Elements in beautiful READMEs include, but not limited to: images, screenshots, GIFs, text formatting, etc.
## General
## Examples
- [sindresorhus/pageres](https://github.com/sindresorhus/pageres) - [sindresorhus/pageres](https://github.com/sindresorhus/pageres)
- [petkaantonov/bluebird](https://github.com/petkaantonov/bluebird) - [petkaantonov/bluebird](https://github.com/petkaantonov/bluebird)
- [jakubroztocil/httpie](https://github.com/jakubroztocil/httpie) - [jakubroztocil/httpie](https://github.com/jakubroztocil/httpie)
## Articles
- [How To Write A Readme](http://jesusabdullah.github.io/2011/11/09/readmes.html)
- [How To Write A Great README](http://robots.thoughtbot.com/how-to-write-a-great-readme)
- [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
- [Top ten reasons why I won’t use your open source project](http://thechangelog.com/top-ten-reasons-why-i-wont-use-your-open-source-project/)
## Contribute ## Contribute
Contributions are always welcome! Contributions are always welcome!