aboutsummaryrefslogtreecommitdiff
path: root/docs/newbs.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2020-02-25 10:58:36 -0800
committerskullydazed <skullydazed@users.noreply.github.com>2020-03-05 16:00:10 -0800
commit45e218ceec1269e5e2751146272637922cd7e9d9 (patch)
tree2dd63b29f8c5a9e3751eeb47a17ef25187525f5d /docs/newbs.md
parent86f6405574d75cdc69c32829cb523aa1538ecd77 (diff)
downloadqmk_firmware-45e218ceec1269e5e2751146272637922cd7e9d9.tar.gz
qmk_firmware-45e218ceec1269e5e2751146272637922cd7e9d9.zip
overhaul the newbs guide
Diffstat (limited to 'docs/newbs.md')
-rw-r--r--docs/newbs.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/newbs.md b/docs/newbs.md
index 3efae9992..389e3f472 100644
--- a/docs/newbs.md
+++ b/docs/newbs.md
@@ -1,6 +1,8 @@
1# The Complete Newbs Guide To QMK 1# The Complete Newbs Guide To QMK
2 2
3QMK is a powerful Open Source firmware for your mechanical keyboard. You can use QMK to customize your keyboard in ways both simple and powerful. People of all skill levels, from complete newbie to master programmer, have successfully used QMK to customize their keyboard. This guide will help you do the same, no matter your skill level. 3Your computer keyboard has a processor inside of it, similar to the one inside your computer. This processor runs software that is responsible for detecting button presses and informing the computer when keys are pressed. QMK Firmware fills the role of that software, detecting button presses and passing that information on to the host computer. When you build your custom keymap, you are creating an executable program for your keyboard.
4
5QMK tries to put a lot of power into your hands by making easy things easy, and hard things possible. You don't have to know how to program to create powerful keymaps — you only have to follow a few simple syntax rules.
4 6
5Not sure if your keyboard can run QMK? If it's a mechanical keyboard you built yourself chances are good it can. We support a [large number of hobbyist boards](http://qmk.fm/keyboards/). If your current keyboard can't run QMK there are a lot of choices out there for boards that do. 7Not sure if your keyboard can run QMK? If it's a mechanical keyboard you built yourself chances are good it can. We support a [large number of hobbyist boards](http://qmk.fm/keyboards/). If your current keyboard can't run QMK there are a lot of choices out there for boards that do.
6 8
@@ -10,17 +12,19 @@ This guide is suitable for everyone who wants to build a keyboard firmware using
10 12
11## Overview 13## Overview
12 14
13There are 6 main sections to this guide: 15There are 4 main sections to this guide:
14 16
151. [Getting Started](newbs_getting_started.md) 171. [Setup Your Environment](newbs_getting_started.md)
162. [Building Your First Firmware](newbs_building_firmware.md) 182. [Building Your First Firmware](newbs_building_firmware.md)
173. [Flashing Firmware](newbs_flashing.md) 193. [Flashing Firmware](newbs_flashing.md)
184. [Testing and Debugging](newbs_testing_debugging.md) 204. [Testing and Debugging](newbs_testing_debugging.md)
195. [Best Git Practices](newbs_git_best_practices.md)
206. [Learn More with these Resources](newbs_learn_more_resources.md)
21 21
22This guide is focused on helping someone who has never compiled software before. It makes choices and recommendations based on that viewpoint. There are alternative methods for many of these procedures, and we support most of those alternatives. If you have any doubt about how to accomplish a task you can [ask us for guidance](getting_started_getting_help.md). 22This guide is focused on helping someone who has never compiled software before. It makes choices and recommendations based on that viewpoint. There are alternative methods for many of these procedures, and we support most of those alternatives. If you have any doubt about how to accomplish a task you can [ask us for guidance](getting_started_getting_help.md).
23 23
24## Additional Resources 24## Additional Resources
25 25
26* [Thomas Baart's QMK Basics Blog](https://thomasbaart.nl/category/mechanical-keyboards/firmware/qmk/qmk-basics/) – A user-created blog covering the basics of how to use QMK Firmware, as seen from a new user's perspective. 26Beyond this guide there are several resources you may find helpful while you learn QMK. We've collected them on the [Learning Resources](newbs_learn_more_resources.md) page.
27
28## Open Source
29
30QMK is Open Source Software released under the GNU General Public License.