summaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2020-02-20 15:50:50 -0800
committerskullydazed <skullydazed@users.noreply.github.com>2020-03-05 16:00:10 -0800
commita701c15d872ad171592335e61e91d7234dbec54a (patch)
treeef06fabdf0c0cd5d7457b63c48264700ac7fc67c /docs/README.md
parent1b7fa46f8e0616450bed8bff71bc1cffbca2eac8 (diff)
downloadqmk_firmware-a701c15d872ad171592335e61e91d7234dbec54a.tar.gz
qmk_firmware-a701c15d872ad171592335e61e91d7234dbec54a.zip
Rework the newbs guide around the qmk cli
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md
index 5f1f297549..477028d105 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -9,7 +9,7 @@
## What is QMK Firmware?
-QMK (*Quantum Mechanical Keyboard*) is an open source community centered around developing computer input devices. Early on the community was keyboard focused, but has now grown to include mice and MIDI devices as well. The community maintains [QMK Firmware](https://github.com/qmk/qmk_firmware), [QMK Configurator](https://config.qmk.fm), [QMK Toolbox](https://github.com/qmk/qmk_toolbox), [qmk.fm](https://qmk.fm), and this documentation.
+QMK (*Quantum Mechanical Keyboard*) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains [QMK Firmware](https://github.com/qmk/qmk_firmware), [QMK Configurator](https://config.qmk.fm), [QMK Toolbox](https://github.com/qmk/qmk_toolbox), [qmk.fm](https://qmk.fm), and this documentation with the help of community members like you.
## Get Started
@@ -18,9 +18,24 @@ Totally new to QMK? There are two ways to get started:
* Basic: [QMK Configurator](https://config.qmk.fm)
* Just select your keyboard from the dropdown and program your keyboard.
* We have an [introductory video](https://www.youtube.com/watch?v=-imgglzDMdY) you can watch.
+ * There is also an overview [document you can read](newbs_building_firmware_configurator.md).
* Advanced: [Use The Source](newbs.md)
* More powerful, but harder to use
## Make It Yours
QMK has lots of [features](features.md) to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md).
+
+## Need help?
+
+Check out the [support page](getting_started_getting_help.md) to see how you can get help using QMK.
+
+## Give Back
+
+There are a lot of ways you can contribute to the QMK Community. The easiest way to get started is to use it and spread the word to your friends.
+
+* Help people out on our forums and chat rooms:
+ * [/r/olkb](https://www.reddit.com/r/olkb/)
+ * [Discord Server](https://discord.gg/Uq7gcHh)
+* Contribute to our documentation by clicking "Edit This Page" at the bottom
+* [Translate our documentation into your language](translating.md)