Hey @matiassingers and watchers: I don't have the resources or desire at the moment to continue moderating this repository. Following my questions, which are still outstanding, in #51, I think other people are in a better position to judge READMEs than I am.

I'd like to move on to focus on different aspects of community development besides READMEs, which I'll keep doing at @mntnr.

I was glad to help when I could. Thank you for the opportunity!

Hey @matiassingers - there are 11 open PRs, and this list hasn't been updated in five months. Do you need help maintaining this list?

Hello,
I'd like to suggest adding GitHub repo https://github.com/akashbijwe to your collection. I think it's a great fit and would appreciate your consideration.

Thanks!

Hey, I'd like you to judge my README and allow me to add to your list if you like it ;)

link

I suggest you add AndrOBD readme to the list because it has a lot of useful ements showcased and it looks and functions well

https://github.com/fr3ts0n/AndrOBD

I admit I haven't had a ton of time lately and had missed out on a lot of notifications and pending PRs here.

@andiemmadavies @waldyrious @Robson I noticed you had all been super helpful with comments and suggestions for submitted READMEs, would any of you be interested in helping out?

READMEs are great and I feel like ARCHITECTURE.md and CONTRIBUTING.md fit in a subcategory of READMEs. I'd be interested to see some good examples of documentation in those spaces here as well!

The link "https://github.com/rayhanadev/rayhanadev#readme" for the README.md exaple rayhanadev/rayhanadev is dead (404).

I was surprised not to see ffmpeg in the README. It's the Swiss Army Knife™ of muxing and works right from Termux on Android, Chromebook and Fire OS:

pkg install ffmpeg && ffmpeg -i infile.mp4 outfile.gif¬

Multiple badges, gif screenshot, online playground, storybook, clear description and more.

https://github.com/dowjones/react-dropdown-tree-select

Hello everyone, I made a small page for this repository:

• website: https://fralfaro.github.io/awesome-readme/

It would be good to have something like the Awesome GitHub Profile READMEs page where some filters have already been defined, to sort the readmes:

• website: https://zzetao.github.io/awesome-github-profile/

Seems like b4b4r07/dotfiles changed.

https://github.com/Day8/re-frame

It doesn't have a fancy logo, nor screenshots, and it's not concise at all(! 7,600 words). But it's very well written and explains the philosophy behind the tech and how to use it in detail. I'd recommend reading it even if you don't use clojurescript, since the ideas stand on their own.

what do you think of this? https://github.com/Harshal2502/OpenSauced-Extension

Please feel free to analyze my readme and recommend the changed and fix to make it more awesome, which can help to make into the list of awesome!

Profile link: https://github.com/sanamhub

PS: PR related to improvements is more than welcome :)

"How To Write A Readme" - Joshua Holbrook

Page not found 404

Hey guys

Most likely it was different when initially added but now the readme of bluebird is lacking.

Perhaps remove it or at least revise it?
https://github.com/petkaantonov/bluebird

Thanks guys!

First, thank you for creating this resource.

I've developed yet another readme template (YART?), called READMINE, based on some of the examples here and my own couple of decades of experience writing open-source software. Would it be possible to add it to this excellent list of awesome readmes?

I'd be happy to do a PR, but I'm uncertain about where a link to READMINE should go. It's less an actual software project README, and more of a template demonstrating a suggested way of writing a README. It's also not an article or a tool. So if your preference is that people do PRs, I would appreciate some guidance about where to make to changes.

This is supplementary to #1.

The links could use a description on why they're included. What makes them good. People that do crappy readme's usually won't realize it when they see better ones.

Example:

Clear description at the top of the readme what the project is. TOC to make it easy to navigate the readme. Quick install and usage section.

I think It'd be great, maybe small web-page for it with filters etc...

Is https://github.com/nasa/ogma a good project to list?

checkout my project: https://github.com/MailOnline/libreact

Notice installation command has a link to the repo on NPM:

npm i libreact --save

Hello, I wrote a tool that can validate README links (valid URLs, not duplicate). It can be run when someone submits a pull request.

It is currently being used by

• https://github.com/vsouza/awesome-ios
• https://github.com/matteocrippa/awesome-swift
• https://github.com/dkhamsing/open-source-ios-apps

Examples

• https://travis-ci.org/matteocrippa/awesome-swift/builds/96526196 ok ✅
• https://travis-ci.org/matteocrippa/awesome-swift/builds/96722421 link redirected / rename 🔴
• https://travis-ci.org/dkhamsing/open-source-ios-apps/builds/96763135 bad link / project deleted 🔴
• https://travis-ci.org/dkhamsing/open-source-ios-apps/builds/95754715 dupe 🔴

If you are interested, connect this repo to https://travis-ci.org/ and add a .travis.yml file to the project.

See https://github.com/dkhamsing/awesome_bot for options, more information
Feel free to leave a comment 😄

sindresorhus/awesome#2008

and thanks for the awesome work so far!

Is https://github.com/ivanperez-keera/Yampa a good project to list?

Hello,

I want to put one of my projects README in the running for awesome READMEs. I've done a lot of edits in trying to kind of format the README in a new formatted way that appeals both to academia and industry.

https://github.com/Sulstice/global-chem

Wondering about y'alls thoughts.

https://github.com/deployphp/deployer

Hi, I found a great free tool for creating an awesome README using a simple method.
readme.so is the easiest way to create a README. Which has a simple editor that allows you to quickly add and customize all the sections you need for your project's readme.

Screenshots :

PR #50 has made me wonder what makes an awesome README a bit more than the other more recent PRs have. There are a ton of great READMEs in this list, but they are all starting to look the same to me, and I suspect people are using the list as an advertisement scheme for themselves instead of as a way to point out ridiculously good documentation.

There are some procedural changes we could put in place to stop this: for instance, asking that PRs get a +1 from a non-contributor before merging, or disabling self-submissions. Another would be having submitters explain why their README is more awesome than others on the list, as a way of judging fitness.

What do you think?

Feedback Demo 1

🥇 Die Note ist: 5.25

👫 Annie
👫 Melanie
👫 Freja

https://github.com/frejalomborgrasmussen/Wetterstation

Allgemein

feedback:

• Präsentation/Demo war sehr interessant.
• Einfache Ziele gesetzt und dadurch Risiken minimiert. Wow.
• Letztes Wochenziel leider nicht erwähnt.
• Was hat gut funktioniert und was hat schlecht funktioniert?
• Wie wollte Ihr euch als Team verbessern?
• Projektidee Ansatzweise erklärt.

Projekt und Architektur

Projekt

👨‍🏫 Proj:

feedback:

• Standard Wetterstation funktioniert (Temperatur, usw..)
• Alle waren sehr fleissig dabei am Projekt mitzuarbeiten.
• Tipp: Issues mit Iterationsmeeting verknüpfen (Meilensteine).
• Burndownchart ausführlich erklärt. Schnittmengen erkannt. Wow.
• Ausblick: Datenbank und Avatare

Architektur

👨‍🏫 Arch:

feedback:

• Client/Server Architektur (1x Master RaspberyPi)
• Vorteile und Nachteile wurde leider zuwenig erwähnt.

Software

Funktionalität

👨‍🏫 Grundfunktionalität:

feedback:

• Wetterstation Grundfunktionalität wurde bereits in der ersten Woche umgesetzt.

Code

👨‍🏫 Code:

feedback:

• Freja hat am meisten commits bzw.code ownership -> evtl. Funktionalität deligieren?
• Readme.md ist sehr mager. Bitte alle eure Infos hier plazieren. Siehe: Gute Beispiele
• Code-Analyse werde ich ab 2. Interationsmeeting machen. Vorab: Bitte auskommentierte Code nicht commiten.

Testing

Unit Tests

👨‍🏫 UnitTest:

feedback:

• Testing nicht im Fokus momentan

Präsentation und Auftritt

• Alle haben etwas präsentiert. Das ist eine gute Idee!
• Alle waren anwesend.

Many of the awesome READMEs here have an animated gif showing usage. Does it make sense to link to the preferred tools for creating these?

Maybe release-it would be a nice addition to your list. Otherwise, I'm happy to hear thoughts on how I could improve that readme.

https://github.com/rstacruz/hicat

🐱 what do ya think?

Not quite sure why, but the Travis Build keeps failing.
Also what does it even do I'm curious?

Not sure about this, but could be interesting to do.

What do you guys think?

I know I sound like a noob because I am one right now.

I created an Extension Pack for the Flutter Community and I believe it has a pretty neat UI with GIF explaining everything. Here is the link - Ultimate Flutter Extension Pack
There aren't many Readme available for Extension Packs so I thought of adding it to the list.
I read the contribution guidelines and I am still learning about git and how to contribute to other people's repository.

TL:DR
If you guys can add a GIF in the Contribution Guidelines on how to do it, it would be great!