From e1f0b5147d6edd626b9e177dd482687331638a6f Mon Sep 17 00:00:00 2001 From: Orangerot Date: Mon, 6 Jan 2025 04:07:55 +0100 Subject: feat: add sample QMK firmware --- geeboard_firmware/qmk/readme.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 geeboard_firmware/qmk/readme.md (limited to 'geeboard_firmware/qmk/readme.md') diff --git a/geeboard_firmware/qmk/readme.md b/geeboard_firmware/qmk/readme.md new file mode 100644 index 0000000..13db351 --- /dev/null +++ b/geeboard_firmware/qmk/readme.md @@ -0,0 +1,27 @@ +# geeboard + +![geeboard](imgur.com image replace me!) + +*A short description of the keyboard/project* + +* Keyboard Maintainer: [Gero Beckmann](https://github.com/Orangerot) +* Hardware Supported: *The PCBs, controllers supported* +* Hardware Availability: *Links to where you can find this hardware* + +Make example for this keyboard (after setting up your build environment): + + make geeboard:default + +Flashing example for this keyboard: + + make geeboard:default:flash + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard +* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available -- cgit v1.2.3