gregdel/gdk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Grégoire Delattre 2020-05-21 10:27:14 +02:00
parent da22befa0c
commit 9997d5bbab
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,3 +1,28 @@
# gregdel's keyboard (gdk) # gregdel's keyboard (gdk)
Firmware: https://config.qmk.fm/#/xd75/LAYOUT_ortho_5x15 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
```