qmk-firmware/docs/_summary.md

• Getting started

  • QMK Overview
  • Build Environment Setup
    • Vagrant Guide
  • Make instructions
  • FAQ: Creating a Keymap
  • FAQ: Compiling QMK
  • How to Github

• Features

  • Layer switching
  • Leader Key
  • Macros
  • Dynamic Macros
  • Space Cadet
  • Tap Dance
  • Mouse keys

• Reference

  • Glossary
  • Keymap overview
  • Keycodes
    • Basic Keycodes
    • Quantum Keycodes
  • The Config File
  • Customizing Functionality
  • Documentation Best Practices

• For makers and modders

  • Adding a keyboard to QMK
  • Porting your keyboard to QMK
  • Modding your keyboard
  • Adding features to QMK
  • ISP flashing guide

• For Deeper Understanding

  • How Keyboards Work
  • Understanding QMK

• Other topics

  • General FAQ
  • Using Eclipse with QMK