From cd8859eaaf9bfa32219be78e89ece93bc77662f6 Mon Sep 17 00:00:00 2001 From: Ross Jacobs <10995145+pocc@users.noreply.github.com> Date: Wed, 1 May 2019 11:50:38 +0100 Subject: [PATCH] Add initial content to README.md --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c03bc23..498566b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ -# awesome-guides -A curated (collaborative) list of Awesome Guides. +# Awesome Guides [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re) + +A curated (collaborative) list of Awesome Guides, under construction. + +**This is a living, breathing Awesome List**. +If you can *personally recommend* a guide, pull requests are welcome! + +- Programming Languages + - [Python Guide](https://docs.python-guide.org) + - [Postgres Guide](http://postgresguide.com) +- Setup + - [WSL Guide](https://wsl-guide.org) +- Style + - [PEP8 Guide](https://pep8.org) + +## Guide(lines) + +![](https://media.giphy.com/media/zEHbc0w8PJ6xy/giphy.gif) + +A guide provides direction on how to use a tool that is separate from reference documentation. A guide should be: + +* Comprehensive on `$subject` without being cumbersome +* Scoped clearly +* Searchable +* Skimmable +* Easy to contribute to +* Updated regularly