aboutsummaryrefslogtreecommitdiff
path: root/keyboards/bpiphany/ghost_squid/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/bpiphany/ghost_squid/readme.md')
-rw-r--r--keyboards/bpiphany/ghost_squid/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/bpiphany/ghost_squid/readme.md b/keyboards/bpiphany/ghost_squid/readme.md
new file mode 100644
index 000000000..ab39e0f72
--- /dev/null
+++ b/keyboards/bpiphany/ghost_squid/readme.md
@@ -0,0 +1,27 @@
1# Ghost Squid Controller
2
3This is the firmware for Rev. 20140518 of the Ghost Squid controller by [Bathroom Epiphanies](http://bathroomepiphanies.com/controllers/), a replacement controller for the [Cooler Master Quick Fire XT](https://www.coolermaster.com/catalog/peripheral/keyboards/quick-fire-xt/).
4
5The code was adapted from the [BathroomEpiphanies QMK Firmware](https://github.com/BathroomEpiphanies/epiphanies_qmk_keyboard/tree/master/keyboards/ghost_squid_20140518).
6
7* Keyboard Maintainer: QMK Community
8* Hardware Supported: Ghost Squid
9* Hardware Availability: [1upkeyboards](https://1upkeyboards.com/shop/controllers/qf-xt-ghost-squid-controller-2/)
10
11Enter the bootloader in 3 ways:
12
13* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
14* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
15* **Keycode in layout**: Press the key mapped to `RESET` if it is available
16
17Make example for this keyboard (after setting up your build environment):
18
19104 key default layout:
20
21 make bpiphany/ghost_squid:default
22
23Flashing example for this keyboard:
24
25 make bpiphany/ghost_squid:default:flash
26
27See 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).