diff options
author | skullY <skullydazed@gmail.com> | 2020-02-25 10:58:36 -0800 |
---|---|---|
committer | skullydazed <skullydazed@users.noreply.github.com> | 2020-03-05 16:00:10 -0800 |
commit | 45e218ceec1269e5e2751146272637922cd7e9d9 (patch) | |
tree | 2dd63b29f8c5a9e3751eeb47a17ef25187525f5d /docs/newbs.md | |
parent | 86f6405574d75cdc69c32829cb523aa1538ecd77 (diff) | |
download | qmk_firmware-45e218ceec1269e5e2751146272637922cd7e9d9.tar.gz qmk_firmware-45e218ceec1269e5e2751146272637922cd7e9d9.zip |
overhaul the newbs guide
Diffstat (limited to 'docs/newbs.md')
-rw-r--r-- | docs/newbs.md | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/newbs.md b/docs/newbs.md index 3efae9992a..389e3f4721 100644 --- a/docs/newbs.md +++ b/docs/newbs.md @@ -1,6 +1,8 @@ # The Complete Newbs Guide To QMK -QMK 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. +Your 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. + +QMK 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. Not 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. @@ -10,17 +12,19 @@ This guide is suitable for everyone who wants to build a keyboard firmware using ## Overview -There are 6 main sections to this guide: +There are 4 main sections to this guide: -1. [Getting Started](newbs_getting_started.md) +1. [Setup Your Environment](newbs_getting_started.md) 2. [Building Your First Firmware](newbs_building_firmware.md) 3. [Flashing Firmware](newbs_flashing.md) 4. [Testing and Debugging](newbs_testing_debugging.md) -5. [Best Git Practices](newbs_git_best_practices.md) -6. [Learn More with these Resources](newbs_learn_more_resources.md) This 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). ## Additional Resources -* [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. +Beyond 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. + +## Open Source + +QMK is Open Source Software released under the GNU General Public License. |