Skip to content

Getting Started ​

  1. Install WSL2
  2. Install the latest release
    install example"
  3. Open the QMK WSL shortcut
    shortcut example"
  4. Run qmk-admin and complete the quickstart wizard
    wizard example"wizard example"wizard example"wizard example"
  5. Run qmk compile
    compile example"
  6. Profit!
    built firmware example"

Next Steps ​

The QMK Tutorial will walk you through creating a keymap for your keyboard.

Need help with something?

The best place to get quick support is going to be on our Discord. There is usually somebody online, and there are a bunch of very helpful people there.

This project is maintained by QMK collaborators and contributors like you!