Awesome-Mirrors/awesome-readme
1
0
Fork 0
mirror of https://github.com/matiassingers/awesome-readme.git synced 2024-10-01 01:05:56 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add DVC project's readme to the list (#89)

Browse Source 
* Add DVC project's readme to the list

It has nice things like custom menu, smooth animation, contribution section with the hall-of-fame plugin.

* Update DVC entry to include information about RST

DVC's readme is a rare example of a great README in RST format. It's important for the compatibility with PyPi.

* Fix typo in the DVC entry
This commit is contained in:
Ivan Shcheklein 2019-08-10 03:18:29 -07:00 committed by Aaron Lichtman
parent 9ff73e392a
commit 2fbc143e08
No known key found for this signature in database
GPG Key ID: 22368077DE9F9903
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
readme.md
View File

@ -18,6 +18,7 @@ Elements in beautiful READMEs include, but are not limited to: images, screensho
- [ccostan/Home-AssistantConfig](https://github.com/CCOSTAN/Home-AssistantConfig) - Project Banner. Badges. Easy navigation.
- [choojs/choo](https://github.com/choojs/choo) - Badges, clean, clear. Beautiful little menu above the fold with useful links. An FAQ inside of it for the main questions. Backers. Good language.
- [Day8/re-frame](https://github.com/Day8/re-frame) - Badges, logo, TOC, etc. Stands out by being a giant, well-written essay about the tech, how to use it, the philosophy behind it, and how it fits into the greater ecosystem.
- [iterative/dvc](https://github.com/iterative/dvc) - ReStructuredText format example, PyPi compatible. Logo, custom website-like menu. Smooth how-it-works animation. Badges. Nice contribution section with the hall-of-fame.
- [github-changelog-generator/github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator) - TOC for easy navigation. Concise project description. Installation and usage sections. Output example. Great feature overview. List of alternatives. FAQ.
- [gitpoint/git-point](https://github.com/gitpoint/git-point) - Clear description. Project Logo. App Store logos. TOC. Clean screenshots. List of features. Detailed installation process. Landing Page.
- [Hexworks/Zircon](https://github.com/Hexworks/zircon) - Dogfood in readme. Clear description of what the project does. Demo screenshot. TOC for easy navigation. Easy installation and setup sections with screenshots. Links for further reading.