Skip to content

A pre-configured WSL distro for working with the QMK CLI

License

Notifications You must be signed in to change notification settings

qmk/qmk_distro_wsl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

QMK WSL

A pre-configured WSL distro for working with the QMK CLI

Latest Release GitHub Workflow Status Discord

Based on the exact same environment as QMK uses for CI, this installer package aims to give you a QMK build environment with as little effort as possible.

terminal example

Documentation

  1. Install WSL2
  2. Install the latest release
  3. Run qmk setup
  4. Run qmk compile
  5. Profit!

Full documentation is available at https://wsl.qmk.fm/.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.