mirrors/opensteno_qmk
1
0
Fork 0
mirror of https://github.com/openstenoproject/qmk synced 2024-11-10 02:30:07 +00:00
Code Issues Projects Releases Packages Wiki Activity
opensteno_qmk/docs/newbs.md

2 KiB
Raw Blame History

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. If your current keyboard can't run QMK there are a lot of choices out there for boards that do.

Is This Guide For Me?

This guide is suitable for everyone who wants to build a keyboard firmware using the source code. If you are already a programmer you will find the process very familiar and easier to follow. If the thought of programming intimidates you please take a look at our online GUI instead.

Overview

There are 6 main sections to this guide:

  1. Getting Started
  2. Building Your First Firmware
  3. Flashing Firmware
  4. Testing and Debugging
  5. Best Git Practices
  6. Learn More with these Resources

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