diff options
Diffstat (limited to 'docs/newbs.md')
| -rw-r--r-- | docs/newbs.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/newbs.md b/docs/newbs.md new file mode 100644 index 000000000..0906e8651 --- /dev/null +++ b/docs/newbs.md @@ -0,0 +1,21 @@ +# The Compelete 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. + +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/), so even if your current keyboard can't run QMK you shouldn't have trouble finding one to suit your needs. + +We assume you are familiar with the basics of working in a Linux/Unix command line environment. If you are not these resources will teach you enough to work with QMK: + +* [Must Know Linux Commands](https://www.guru99.com/must-know-linux-commands.html) +* [Some Basic Unix Commands](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html) + +## Overview + +There are 4 main sections to this guide: + +* [Getting Started](newbs_getting_started.md) +* [Building Your First Firmware](newbs_building_firmware.md) +* [Flashing Firmware](newbs_flashing.md) +* [Testing and Debugging](newbs_testing_debugging.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). |