diff --git a/404.html b/404.html index 64dfce2..07e8b65 100644 --- a/404.html +++ b/404.html @@ -16,7 +16,7 @@
- + \ No newline at end of file diff --git a/dev.html b/dev.html index caa91d2..7994a23 100644 --- a/dev.html +++ b/dev.html @@ -20,7 +20,7 @@
QMK WSL

Appearance

Contributing ​

👍🎉 First off, thanks for taking the time to read this and contribute! 🎉👍

Third-party contributions help us grow and improve QMK. We want to make the pull request and contribution process useful and easy for both contributors and maintainers.

Bugs/Enhancements ​

Found something that is broken or could be improved?

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.

Otherwise raise an issue, with any additional details you can provide.

Documentation ​

Want to improve the documentation?

Powered by vitepress, and hosted on GitHub Pages, you can request changes by making a fork and pull request.

Previewing the Documentation ​

Before opening a pull request, you can preview your changes with the following command:

console
yarn install
 yarn serve

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

- + \ No newline at end of file diff --git a/faq.html b/faq.html index c6b212a..e0965d1 100644 --- a/faq.html +++ b/faq.html @@ -21,7 +21,7 @@
QMK WSL

Appearance

Frequently Asked Questions ​

Why can't I flash my keyboard from within WSL? ​

While currently a limitation of WSL, workarounds have been included for flashing the following:

  • avrdude
  • dfu-util
  • dfu-programmer
  • bootloadHid
  • teensy-loader-cli

The recommendation is to use QMK Toolbox for all other supported flashing methods.

How can I flash with QMK Toolbox? ​

Files within the WSL filesystem can be flashed directly by using

\\wsl$\QMK\home\qmk\qmk_firmware\<firmware_name.ext>

For example,

toolbox example"

How can I access my firmware files? ​

Within the WSL shell, you can run the following command to start browsing

console
wstart ~/qmk_firmware

Why is <action> so slow? ​

Due to limitations with WSL2, file access can be summarized as either:

  • Linux - fast but files are isolated and might be lost if not careful
  • Windows - extremely slow but files are generally safer due to the single filesystem

Is is recommended to use the Linux filesystem where possible. When running qmk setup manually, ensure that it is located inside the WSL instance instead of the Windows filesystem (ie. not in /mnt) with the -H option.

For more info see: https://docs.microsoft.com/en-us/windows/wsl/compare-versions

For new users, it is also recommended to enable automatic backups. This can re-configured with the 'Backup/Restore' menu within the qmk-admin TUI.

How do I keep my environment up to date? ​

Periodic updates will be available to cover both major OS, and QMK CLI updates. Installing the most recent release will ensure you have the latest requirements to build QMK firmware.

Interim updates have to be performed manually. This can done with the 'Update System' item within the qmk-admin TUI or by running the following commands:

console
sudo apt update
 sudo apt upgrade -y
 sudo python3 -m pip install qmk --upgrade

More Coming Soon... ​

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!

- + \ No newline at end of file diff --git a/guide.html b/guide.html index 94bcd2a..e6359c1 100644 --- a/guide.html +++ b/guide.html @@ -19,7 +19,7 @@
QMK WSL

Appearance

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!

- + \ No newline at end of file diff --git a/hashmap.json b/hashmap.json index 06082a3..1dff0b6 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"dev.md":"BvruYDEt","faq.md":"Bnuo5OYp","index.md":"EDD6CDqi","guide.md":"2W28tL9D"} +{"dev.md":"BvruYDEt","faq.md":"Bnuo5OYp","guide.md":"2W28tL9D","index.md":"EDD6CDqi"} diff --git a/index.html b/index.html index 3566742..30836ac 100644 --- a/index.html +++ b/index.html @@ -19,7 +19,7 @@
QMK WSL

Appearance

QMK WSL

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

Get Started →

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"

Not using Windows? Go directly to the Tutorial to get started.

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

- + \ No newline at end of file