aboutsummaryrefslogtreecommitdiff
path: root/docs/faq_general.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/faq_general.md
parent1b7fa46f8e0616450bed8bff71bc1cffbca2eac8 (diff)
downloadqmk_firmware-a701c15d872ad171592335e61e91d7234dbec54a.tar.gz
qmk_firmware-a701c15d872ad171592335e61e91d7234dbec54a.zip
Rework the newbs guide around the qmk cli
Diffstat (limited to 'docs/faq_general.md')
-rw-r--r--docs/faq_general.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/faq_general.md b/docs/faq_general.md
index f14272ede..8e9771cbc 100644
--- a/docs/faq_general.md
+++ b/docs/faq_general.md
@@ -4,6 +4,44 @@
4 4
5[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). 5[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).
6 6
7## I don't know where to start!
8
9If this is the case, then you should start with our [Newbs Guide](newbs.md). There is a lot of great info there, and that should cover everything you need to get started.
10
11If that's an issue, hop onto the [QMK Configurator](https://config.qmk.fm), as that will handle a majority of what you need there.
12
13## How can I flash the firmware I built?
14
15First, head to the [Compiling/Flashing FAQ Page](faq_build.md). There is a good deal of info there, and you'll find a bunch of solutions to common issues there.
16
17## What if I have an issue that isn't covered here?
18
19Okay, that's fine. Then please check the [open issues in our GitHub](https://github.com/qmk/qmk_firmware/issues) to see if somebody is experiencing the same thing (make sure it's not just similar, but actually the same).
20
21If you can't find anything, then please open a [new issue](https://github.com/qmk/qmk_firmware/issues/new)!
22
23## What if I found a bug?
24
25Then please open an [issue](https://github.com/qmk/qmk_firmware/issues/new), and if you know how to fix it, open up a Pull Request on GitHub with the fix.
26
27## But `git` and `GitHub` are intimidating!
28
29Don't worry, we have some pretty nice [Guidelines](newbs_git_best_practices.md) on how to start using `git` and GitHub to make things easier to develop.
30
31Additionally, you can find additional `git` and GitHub related links [here](newbs_learn_more_resources.md).
32
33## I have a Keyboard that I want to add support for
34
35Awesome! Open up a Pull Request for it. We'll review the code, and merge it!
36
37### What if I want to do brand it with `QMK`?
38
39That's amazing! We would love to assist you with that!
40
41In fact, we have a [whole page](https://qmk.fm/powered/) dedicated to adding QMK Branding to your page and keyboard. This covers pretty much everything you need (knowledge and images) to officially support QMK.
42
43If you have any questions about this, open an issue or head to [Discord](https://discord.gg/Uq7gcHh).
44
7## What Differences Are There Between QMK and TMK? 45## What Differences Are There Between QMK and TMK?
8 46
9TMK was originally designed and implemented by [Jun Wako](https://github.com/tmk). QMK started as [Jack Humbert](https://github.com/jackhumbert)'s 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. 47TMK was originally designed and implemented by [Jun Wako](https://github.com/tmk). QMK started as [Jack Humbert](https://github.com/jackhumbert)'s 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.