colin
/
qmk
1
0
Fork 0
Code Pull Requests Packages Activity

Update README.md

This commit is contained in:
colin 2024-02-29 00:51:02 +00:00
parent e56ab24ccd
commit c347b530cc
1 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,5 +1,4 @@
Based on the structure of the provided README example, here's how you can communicate the usage of the Docker container for compiling QMK firmware with Docker Compose, incorporating environment variables for dynamic behavior: <!-- #build 0 -->
# QMK Firmware Compiler # QMK Firmware Compiler
Compile your QMK firmware easily with Docker. This setup allows you to compile firmware from a directory of source files at runtime, ensuring flexibility for various keyboard and keymap compilations. Compile your QMK firmware easily with Docker. This setup allows you to compile firmware from a directory of source files at runtime, ensuring flexibility for various keyboard and keymap compilations.
@ -52,6 +51,4 @@ To customize your firmware compilation, you can adjust the following environment
- **Environment Variables (Optional):** - **Environment Variables (Optional):**
- `KEYBOARD`: Specify the keyboard for which the firmware is being compiled. This variable can be used in your `compile_firmware.sh` script to dynamically select the keyboard. - `KEYBOARD`: Specify the keyboard for which the firmware is being compiled. This variable can be used in your `compile_firmware.sh` script to dynamically select the keyboard.
- `KEYMAP`: Specify the keymap to be compiled. Similar to `KEYBOARD`, this can be used in the script to select the appropriate keymap. - `KEYMAP`: Specify the keymap to be compiled. Similar to `KEYBOARD`, this can be used in the script to select the appropriate keymap.
This configuration allows for a highly flexible and repeatable process for compiling QMK firmware, accommodating various keyboards and keymaps by simply adjusting the mounted volumes and, optionally, setting environment variables for specific compilations.