mirror of
https://github.com/kennethreitz-archive/awesome-guides.git
synced 2026-06-05 07:06:15 +00:00
Add initial content to README.md
This commit is contained in:
@@ -1,2 +1,27 @@
|
||||
# awesome-guides
|
||||
A curated (collaborative) list of Awesome Guides.
|
||||
# Awesome Guides [](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)
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user