From 9997d5bbaba5180c088e12e83cd33364a6a5ad48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Delattre?= Date: Thu, 21 May 2020 10:27:14 +0200 Subject: [PATCH] Update readme --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 83a1a00..55e32c3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ # gregdel's keyboard (gdk) 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. + +```sh +qmk new-keymap +``` + +2. Generate the json configuration using the online tool. + +3. 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. + +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. + +```sh +sudo qmk flash --keyboard xd75 --keymap gdk +```