summaryrefslogtreecommitdiff
path: root/keyboard/kmac/README.md
diff options
context:
space:
mode:
authorRyan Ascheman <rascheman@groupon.com>2016-10-18 12:42:02 -0700
committerRyan Ascheman <rascheman@groupon.com>2016-10-18 12:42:02 -0700
commit55b8b8477cc6aee82dfe6792eea4e589cac433d5 (patch)
treece5bfbd1b0ee59dbffdc2044bcf90c89614392ed /keyboard/kmac/README.md
parentd1c70328f8d8ded6ce1e5422b468fc41ef315e7d (diff)
parent04df74f6360464661bcc1e6794e9fd3549084390 (diff)
Merge remote-tracking branch 'upstream/master'
* upstream/master: (1239 commits) Update ez.c removes planck/rev3 temporarily Move hand_swap_config to ez.c, removes error for infinity Update Makefile ergodox: Update algernon's keymap to v1.9 Added VS Code dir to .gitignore Support the Pegasus Hoof controller. [Jack & Erez] Simplifies and documents TO add readme use wait_ms instead of _delay_ms add messenger init keymap Add example keymap Adding whiskey_tango_foxtrot_capslock ergodox keymap Unicode map framework. Allow unicode up to 0xFFFFF using separate mapping table CIE 1931 dim curve Apply the dim curve to the RGB output Update the Cluecard readme files Tune snake and knight intervals for Cluecard Tunable RGB light intervals ...
Diffstat (limited to 'keyboard/kmac/README.md')
-rw-r--r--keyboard/kmac/README.md110
1 files changed, 0 insertions, 110 deletions
diff --git a/keyboard/kmac/README.md b/keyboard/kmac/README.md
deleted file mode 100644
index dc35870caa..0000000000
--- a/keyboard/kmac/README.md
+++ /dev/null
@@ -1,110 +0,0 @@
-KMAC keyboard firmware
-======================
-Korean custom keyboard designed by Byungho Kim and KBDMania community.
-
-*Note that this is not the official firmware*
-
-Supported models
-----------------
-At the moment only the TKL models is supported.
-
-
-Build
------
-Move to this directory then just run `make` like:
-
- $ make -f Makefile.[pjrc|lufa] [winkey|winkeyless]
-
-Use `Makefile.pjrc` if you want to use PJRC stack or use `Makefile.lufa` for LUFA stack.
-
-
-Bootloader
----------
-The PCB is hardwired to run the bootloader if the key at the `Caps Lock` position is held down when connecting the keyboard.
-
-It is still possible to use Boot Magic and Command to access the bootloader though.
-
-
-Keymap
-------
-There are 2 different types of PCB.
-They each have their own keymap file.
-
-To customize a keymap:
- 1. Edit the file that corresponds to your PCB.
- 2. Specify your layout when building.
-
-### 1. Winkey
-This is the default keymap.
-
-See [keymap_winkey.h](keymap_winkey.h) for detail.
-
-#### 1.0. Winkey Default Layer
- ,---. ,---------------. ,---------------. ,---------------. ,-----------.
- |Esc| |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
- `---' `---------------' `---------------' `---------------' `-----------'
- ,-----------------------------------------------------------. ,-----------.
- |~ | 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp | |Ins|Hom|PgU|
- |-----------------------------------------------------------| |-----------|
- |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \| |Del|End|PgD|
- |-----------------------------------------------------------| '-----------'
- |Fn0 | A| S| D| F| G| H| J| K| L| ;| '|Return |
- |-----------------------------------------------------------| ,---.
- |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift | |Up |
- |-----------------------------------------------------------| ,-----------.
- |Ctl|Gui|Alt| Space |Alt|Gui|App|Ctl| |Lef|Dow|Rig|
- `-----------------------------------------------------------' `-----------'
-
-#### 1.1. Winkey Media Layer
- ,---. ,---------------. ,---------------. ,---------------. ,-----------.
- |Led| | | | | | | | | | | | | | | | | | |Slp|
- `---' `---------------' `---------------' `---------------' `-----------'
- ,-----------------------------------------------------------. ,-----------.
- | | | | | | | | | | |Mut|V- |V+ | | | | | |
- |-----------------------------------------------------------| |-----------|
- | | | | | | | | | |Stp|Ply|Prv|Nxt|Media| | | | |
- |-----------------------------------------------------------| '-----------'
- | | | | | | | | | | | | | |
- |-----------------------------------------------------------| ,---.
- | | | |Clc| | | | | | | |Caps | | |
- |-----------------------------------------------------------| ,-----------.
- | | | | | | | | | | | | |
- `-----------------------------------------------------------' `-----------'
-
-
-### 2. Winkeyless
-Layout with 1.5 unit modifiers.
-
-See [keymap_winkeyless.h](keymap_winkeyless.h) for detail.
-
-#### 2.0. Winkeyless Default Layer
- ,---. ,---------------. ,---------------. ,---------------. ,-----------.
- |Esc| |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
- `---' `---------------' `---------------' `---------------' `-----------'
- ,-----------------------------------------------------------. ,-----------.
- |~ | 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp | |Ins|Hom|PgU|
- |-----------------------------------------------------------| |-----------|
- |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \| |Del|End|PgD|
- |-----------------------------------------------------------| '-----------'
- |Fn0 | A| S| D| F| G| H| J| K| L| ;| '|Return |
- |-----------------------------------------------------------| ,---.
- |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift | |Up |
- |-----------------------------------------------------------| ,-----------.
- |Ctl |Gui|Alt | Space |Alt |Gui|Ctl | |Lef|Dow|Rig|
- `-----------------------------------------------------------' `-----------'
-
-#### 2.1. Winkeyless Media Layer
- ,---. ,---------------. ,---------------. ,---------------. ,-----------.
- |Led| | | | | | | | | | | | | | | | | | |Slp|
- `---' `---------------' `---------------' `---------------' `-----------'
- ,-----------------------------------------------------------. ,-----------.
- | | | | | | | | | | |Mut|V- |V+ | | | | | |
- |-----------------------------------------------------------| |-----------|
- | | | | | | | | | |Stp|Ply|Prv|Nxt|Media| | | | |
- |-----------------------------------------------------------| '-----------'
- | | | | | | | | | | | | | |
- |-----------------------------------------------------------| ,---.
- | | | |Clc| | | | | | | |Caps | | |
- |-----------------------------------------------------------| ,-----------.
- | | | | | | | | | | | |
- `-----------------------------------------------------------' `-----------'