diff options
author | Nick Brassel <nick@tzarc.org> | 2022-10-03 07:24:22 +1100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-03 07:24:22 +1100 |
commit | 9ecd6eb9b9ddf487ced76bf0b5114674cf61432b (patch) | |
tree | 3dec8ebc6f6af5995e8b3a59cedb212cf6c94871 /keyboards/tzarc/ghoul/readme.md | |
parent | 2b3f6d0ec6bf504b0b5794bd4f1f3ed7e792a221 (diff) |
Add `tzarc/ghoul`. (#18562)
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/tzarc/ghoul/readme.md')
-rw-r--r-- | keyboards/tzarc/ghoul/readme.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/tzarc/ghoul/readme.md b/keyboards/tzarc/ghoul/readme.md new file mode 100644 index 0000000000..39c51377bc --- /dev/null +++ b/keyboards/tzarc/ghoul/readme.md @@ -0,0 +1,29 @@ +# Ghoul + + + +Planck-like development board for QMK, using SparkFun MicroMod for hot-swap MCU capability. + +* Keyboard Maintainer: [tzarc](https://github.com/tzarc) +* Hardware Supported: Ghoul rev1 PCB + MicroMod STM32, MicroMod RP2040 +* Hardware Availability: [Open-source](https://github.com/tzarc/ghoul) + +Make example for this keyboard (after setting up your build environment): + + make tzarc/ghoul/rev1/stm32:default + make tzarc/ghoul/rev1/rp2040:default + +Flashing example for this keyboard: + + make tzarc/ghoul/rev1/stm32:default:flash + make tzarc/ghoul/rev1/rp2040: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 top-left key (usually Escape) and plug in the keyboard +* **Physical reset button**: Either press all 5 left-most keys on the bottom row, or hold `BOOT` and press `RESET` +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available |