diff --git a/README.md b/README.md index 8dc0e84..9981acb 100644 --- a/README.md +++ b/README.md @@ -4,22 +4,30 @@ Firmware: https://config.qmk.fm/#/xd75/LAYOUT_ortho_5x15 # Flashing the firmware -1. Install the qmk command line tool and all the dependecies. Create a new keymap for your keyboard. +Install the qmk command line tool and all the dependecies. Create a new keymap for your keyboard. ```sh qmk new-keymap ``` -2. Generate the json configuration using the online tool. +Generate the json configuration using the online tool. -3. Download the generated json and convert it to a keymap.c +## Automatic installation + +```sh +./build-and-flash +``` + +## Manual installation + +Download the generated json and convert it to a keymap.c ```sh cd ~/your/qmk/repo qmk json2c -o keyboards/xd75/keymaps/gdk/keymap.c ~/downloads/gdk.json ``` -4. Compile and flash the firmware. +Compile and flash the firmware. To be able to flash the firmware you must enter the keyboard in the "DFU" state. Don't forget to add a "Reset" binding on your keyboard to be able to flash it easily. diff --git a/build.sh b/build-and-flash similarity index 100% rename from build.sh rename to build-and-flash