From c347b530cc20d424ee65f1fdd53cb47be69a4c9f Mon Sep 17 00:00:00 2001 From: colin Date: Thu, 29 Feb 2024 00:51:02 +0000 Subject: [PATCH] Update README.md --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 195604d..809fae4 100644 --- a/README.md +++ b/README.md @@ -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: - + # 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. @@ -52,6 +51,4 @@ To customize your firmware compilation, you can adjust the following environment - **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. - - `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. \ No newline at end of file + - `KEYMAP`: Specify the keymap to be compiled. Similar to `KEYBOARD`, this can be used in the script to select the appropriate keymap. \ No newline at end of file