summaryrefslogtreecommitdiffstats
path: root/docs/faq_general.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-08-06 05:54:34 +0200
committerJack Humbert <jack.humb@gmail.com>2017-08-16 21:47:20 +0200
commite6c638bed1fa0a48bb6f8697b2a61717c4fd0992 (patch)
treed82e001a7fe61eeb6311efc69ec95e03aa69bdfa /docs/faq_general.md
parent89bcdde92779d5f9a4ca5a3947d5720baf09b75c (diff)
downloadqmk_firmware-e6c638bed1fa0a48bb6f8697b2a61717c4fd0992.tar.gz
qmk_firmware-e6c638bed1fa0a48bb6f8697b2a61717c4fd0992.tar.xz
Overhaul the Getting Started section and add a FAQ section
Diffstat (limited to 'docs/faq_general.md')
-rw-r--r--docs/faq_general.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/faq_general.md b/docs/faq_general.md
new file mode 100644
index 000000000..efa564743
--- /dev/null
+++ b/docs/faq_general.md
@@ -0,0 +1,20 @@
+# Frequently Asked Questions
+
+## What is QMK?
+
+[QMK](https://github.com/qmk), short for Quantum Mechanical Keyboard, is a group of people building tools for custom keyboards. We started with the [QMK firmware](https://github.com/qmk/qmk_firmware), a heavily modified fork of [TMK](https://github.com/tmk/tmk_keyboard).
+
+### Why the name Quantum?
+
+<!-- FIXME -->
+
+## What Differences Are There Between QMK and TMK?
+
+TMK was originally designed and implemented by [Jun Wako](https://github.com/tmk). QMK started as [Jack Humbert's](https://github.com/jackhumbert) fork of TMK for the Planck. After a while Jack's fork had diverged quite a bit from TMK, and in 2015 Jack decided to rename his fork to QMK.
+
+From a technical standpoint QMK builds upon TMK by adding several new features. Most notably QMK has expanded the number of available keycodes and uses these to implement advanced features like `S()`, `LCTL()`, and `MO()`. You can see a complete list of these keycodes in [Quantum Keycodes](quantum_keycodes.html).
+
+From a project and community management standpoint TMK maintains all the officially supported keyboards by himself, with a bit of community support. Separate community maintained forks exist or can be created for other keyboards. Only a few keymaps are provided by default, so users typically don't share keymaps with each other. QMK encourages sharing of both keyboards and keymaps through a centrally managed repository, accepting all pull requests that follows the quality standards. These are mostly community maintained, but the QMK team also helps when necessary.
+
+Both approaches have their merits and their drawbacks, and code flows freely between TMK and QMK when it makes sense.
+