~ruther/qmk_firmware

ref: a58c66df88d1da9c57e5e4ccffb78c7882b55706 qmk_firmware/docs/newbs.md -rw-r--r-- 1.7 KiB
a58c66df — Drashna Jaelre Reduce CRKBD firmware size by reducing layer numbers (#5471) 6 years ago

#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.

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, so even if your current keyboard can't run QMK you shouldn't have trouble finding one to suit your needs.

#Overview

There are 7 main sections to this guide:

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.

#Additional Resources