ergodone-keyboard/README.md

29 lines
1.1 KiB
Markdown
Raw Normal View History

# Dejvino's ErgoDone Keyboard Firmware
2023-10-22 03:44:46 +00:00
## Setup
1. Clone this repo in recursive mode (with submodules): `git clone --recurse-submodules <url>`
2. Setup QMK (see [docs](https://docs.qmk.fm/#/newbs_getting_started))
1. Install qmk helper: `python3 -m pip install --user qmk`
2. Run the setup: `qmk setup`
2023-10-22 04:02:58 +00:00
3. Install Dejvino's keyboard layout: `ln -s $(pwd)/../keymap keyboards/ktec/ergodone/keymaps/dejvino`
2023-10-22 03:44:46 +00:00
## Compile
2023-10-22 04:05:56 +00:00
Run: `make build`
2023-10-22 03:44:46 +00:00
## Flash
If you're not on Linux, download the [TKG Toolkit](https://github.com/kairyu/tkg-toolkit) flashing utility for your system manually, otherwise let `make` do it.
2023-10-22 03:44:46 +00:00
1. Enter flashing mode
1. Disconnect KBD
2. Press and hold two top-right-most keys on the left-half KBD
3. Connect KBD (LEDs will be blinking)
2023-10-22 04:05:56 +00:00
2. Run: `make flash`
2023-10-22 04:05:56 +00:00
Tip: just run `make` to compile & flash.
(see [ErgoDone Readme](https://github.com/qmk/qmk_firmware/blob/master/keyboards/ktec/ergodone/readme.md) for details on flashing)
## Resources
- [QMK Firmware](https://github.com/qmk/qmk_firmware)
- [TKG Toolkit](https://github.com/kairyu/tkg-toolkit)