Add initial content to README.md

This commit is contained in:
Ross Jacobs
2019-05-01 11:50:38 +01:00
committed by GitHub
parent ddd1422b7a
commit cd8859eaaf
+27 -2
View File
@@ -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