summaryrefslogtreecommitdiffstats
path: root/keyboards/gray_studio/cod67/readme.md
diff options
context:
space:
mode:
authorRys Sommefeldt <rys@sommefeldt.com>2019-11-09 02:30:44 +0000
committerDrashna Jaelre <drashna@live.com>2019-11-08 18:30:44 -0800
commit26ce66e30675ebc785ac3e2e6bd1deeb479cb7e1 (patch)
treec9e55e905679937145884e96b82d96d7832f76a6 /keyboards/gray_studio/cod67/readme.md
parentc1970e284d9718a62a973442ec9f0801365cff60 (diff)
[Keyboard] Update COD67 support to complete it and add a personal map (#7291)
* Update docs for default keymap * Update COD67 docs with fixes and macOS details * Add a personal COD67 2-layer map with RGB control * Enable RGB, NKRO and change firmware format to bin * Swap k0D and k48 to fix backspace on the top row * Add RGB config and tidy up a bit * Finish default map because merlin was full of bbq * Whoops, rogue tabs * Typo fix in the main COD67 readme * Remove empty function defs in keymap * Swap how the backspace key relocation happens * Fix PRODUCT_ID and add a link to software PWM docs * Disable NKRO and bootmagic and enable mouse keys * Better header guard * Whoops, forgot to remote the #endif
Diffstat (limited to 'keyboards/gray_studio/cod67/readme.md')
-rw-r--r--keyboards/gray_studio/cod67/readme.md35
1 files changed, 25 insertions, 10 deletions
diff --git a/keyboards/gray_studio/cod67/readme.md b/keyboards/gray_studio/cod67/readme.md
index 7f91cf30d1..6e79ffec4a 100644
--- a/keyboards/gray_studio/cod67/readme.md
+++ b/keyboards/gray_studio/cod67/readme.md
@@ -1,30 +1,45 @@
# Gray COD67
-The Gray COD67 is a 60% keyboard with a modern and bold design. It features 20 RGB Underglow LED lights and a unique diffuser placement. The COD67 has the most stunning RGB light strip for a custom mechanical keyboard. It also features a center mounted USB C port.
+The Gray COD67 is a 60% keyboard with a modern and bold design. It features 20 RGB Underglow LED lights and a unique diffuser placement. The COD67 has the most stunning RGB light strip for a custom mechanical keyboard. It also features a center mounted USB C port.
-There were only 75 units made worldwide.
+There were only 75 units made worldwide.
Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
Hardware Supported: Gray COD67
Hardware Availability: [Zfrontier](https://en.zfrontier.com/products/cod67)
-At this time, flashing ONLY works on Windows systems.
+## Bootloader mode
-To put in bootloader mode, hold the `Esc` key while plugging in the USB cable.
+To put in bootloader mode, hold the `Esc` key while plugging in the USB cable.
-The COD67 will show up as a drive.
+## Making firmware
Make example for this keyboard (after setting up your build environment):
- make gray_studio/cod67:default:bin
+ make gray_studio/cod67:default
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).
-Rename the resulting `.bin` file to `cod67.bin`.
+## Flashing in Windows
-Drag and drop `cod67.bin` to the drive, overwriting the previous `cod67.bin` stored on it.
+After putting your COD67 in bootloader mode, it will show up as a drive.
-Press the `Esc` key again to reset the board. You are now ready to type!
+* Rename the resulting `.bin` file to `COD67.BIN`.
+* Drag and drop your new `COD67.BIN` to the drive, overwriting the previous `COD67.BIN` stored on it.
+* Wait a few seconds for it to write. The caps lock LED flashes rapidly while writing.
+* Press the `Esc` key again to reset the board. You are now ready to type!
+
+## Flashing in macOS
+
+After putting your COD67 in bootloader mode, it will show up as a drive.
+
+* Rename the resulting `.bin` file to `COD67.BIN`.
+* Drag the existing `COD67.BIN` file from the drive to the Trash in Finder.
+* Empty the Trash in Finder. It's important you do that due to how macOS handles hidden `.Trashes` on removable drives. It needs to be empty to free up flash space.
+* Drag and drop your new `COD67.BIN` to the drive.
+* Wait a few seconds for it to write. The caps lock LED flashes rapidly while writing.
+* Press the `Esc` key or eject the drive in Finder to reset the board. You are now ready to type!
## Notes
-The backlight pin is attached to a non PWM pin `D4` so backlight is only on/off.
+
+The backlight pin is attached to a non PWM pin `D4` so the backlight is only on/off.