summaryrefslogtreecommitdiffstats
path: root/docs/getting_started_getting_help.md
diff options
context:
space:
mode:
authorskullydazed <skullydazed@users.noreply.github.com>2018-03-06 23:37:48 +0100
committerGitHub <noreply@github.com>2018-03-06 23:37:48 +0100
commit08e48eb6f534c7eeb692e8e63b81f41110dcb5e3 (patch)
tree185ec53e454639431fdaa0d998407361986940db /docs/getting_started_getting_help.md
parent12c8ee956dc0230b571bc51f785ae417073d5c67 (diff)
downloadqmk_firmware-08e48eb6f534c7eeb692e8e63b81f41110dcb5e3.tar.gz
qmk_firmware-08e48eb6f534c7eeb692e8e63b81f41110dcb5e3.tar.xz
Add a newbie guide for people completely new to QMK (#2480)
Diffstat (limited to 'docs/getting_started_getting_help.md')
-rw-r--r--docs/getting_started_getting_help.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/getting_started_getting_help.md b/docs/getting_started_getting_help.md
new file mode 100644
index 000000000..7fb3b49e9
--- /dev/null
+++ b/docs/getting_started_getting_help.md
@@ -0,0 +1,21 @@
+# Getting Help
+
+There are a lot of resources for getting help with QMK.
+
+## Realtime Chat
+
+You can find QMK developers and users on our main [gitter chat room](https://gitter.im/qmk/qmk_firmware). We also have other rooms for more specific discussion:
+
+* [Main Firmware Chat](https://gitter.im/qmk/qmk_firmware)
+* [QMK Toolbox](https://gitter.im/qmk/qmk_toolbox)
+* [Hardware Design Discussion](https://gitter.im/qmk/qmk_hardware)
+* [Web Configurator](https://gitter.im/qmk/qmk_configurator)
+* [Compiler API](https://gitter.im/qmk/qmk_compiler_api)
+
+## OLKB Subreddit
+
+The official QMK forum is [/r/olkb](https://reddit.com/r/olkb) on [reddit.com](https://reddit.com).
+
+## Github Issues
+
+You can open an [issue on GitHub](https://github.com/qmk/qmk_firmware/issues). This is especially handy when your issue will require long-term discussion or debugging.