Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Commit my DZ60 keymap #4375

Merged
merged 13 commits into from
Nov 6, 2018
Merged

Commit my DZ60 keymap #4375

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
77cee59
default mechmerlin keymap initial commit
mechmerlin Nov 6, 2018
97485a8
fix up the keymap
mechmerlin Nov 6, 2018
c2ed4bc
cleanup keymap
mechmerlin Nov 6, 2018
ad0b0cd
add rgb sleep functionality
mechmerlin Nov 6, 2018
dff949f
add the beginning of a readme
mechmerlin Nov 6, 2018
f0c5661
fix that compile error
mechmerlin Nov 6, 2018
0fc8e8d
fixup formatting
mechmerlin Nov 6, 2018
8ee7122
spruce up that readme
mechmerlin Nov 6, 2018
d44a3f1
add RGB lighting controls to _CL layer
mechmerlin Nov 6, 2018
1e2df0d
update readme
mechmerlin Nov 6, 2018
496b17b
set rgb underglow color
mechmerlin Nov 6, 2018
2ec21ef
update readme
mechmerlin Nov 6, 2018
d2942ce
fix formatting
mechmerlin Nov 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
spruce up that readme
  • Loading branch information
@mechmerlin
mechmerlin committed Nov 6, 2018
commit 8ee712243456d40535b337f8254f1adab5669316
55 changes: 53 additions & 2 deletions keyboards/dz60/keymaps/mechmerlin/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,62 @@

The purpose of this keymap is to provide examples on how to do some common QMK features.

## Merlin's DZ60 Info
Make example for this keyboard (after setting up your build environment):

make dz60:mechmerlin

## Merlin's DZ60 Hardware Info
---

The DZ60 is a 60% pcb produced by KBDFans. It comes in two variants, USB Mini B and USB C. It supports many many layouts. It also supports both backlight and RGB underglow. The USB C variant does not have a hardware reset switch. USB C to C is not supported.

Merlin's DZ60 uses
- Layout B
- Layout B, in QMK this is LAYOUT_60_b_ansi.
- USB C
- 50g Zilents
- Arrows are 78g Zilents
- KPRepublic XD64 Case

## Layers
---

Merlin's keymap has three different layers. To switch layers you can use the `MO(X)` keycode, where `X` is the layer you want to switch to.

### _BL

This is the base layer also known as layer 0. It is a standard QWERTY layout.

### _FL

This is the function layer also known as layer 1. It utiizes the following:
- Function Keys
- Navigation Keys
- Audio keys such as Mute, Volume Down and Volume Up.

### _CL

This is the control layer also known as layer 2. It utilizes the following:
- RGB Controls
- `RESET` key

## Non Standard Keycodes
---
### RESET

As long `BOOTMAGIC_ENABLE` is set to `yes` in `rules.mk`, the DZ60 can be put into bootloader mode by holding the `space` key and the `b` key while plugging in. However sometmes this doesn't work or is troublesome to do, might as well use the `RESET` keycode to accomplish this.

### RSFT_T(KC_SLSH)

Layout B is missing the `?` key and is instead replaced with a `right shift`. This keycode makes it so that the key can be tapped for `?` and held for `right shift`.

### LCTL_T(KC_CAPS)

`Caps Lock` is only ever used by tapping, why not use it as a `control` key when held? This keycode makes it so that the key can be tapped for `caps lock` and held for `control`.


## RGB Lighting
---

### RGBLIGHT_SLEEP

This is set in `mechmerlin/config.h` so that when the computer goes to sleep, the RGB lights will also go to sleep on the keyboard. They will turn back on when the computer wakes.