summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBalz Guenat <balz.guenat@gmail.com>2017-08-07 21:54:06 +0200
committerBalz Guenat <balz.guenat@gmail.com>2017-08-07 21:54:06 +0200
commitd18df8ef7a7e0528a29fdc96d4843ace54605121 (patch)
tree44f75b9bccd3efa130d622736726a5f1c83531f6
parent308bec28bb76f4305d0f084252d7cf207f1b3d83 (diff)
parent933701c2129c0c585ecd8ba37c41b091a7dc687f (diff)
Merge remote-tracking branch 'upstream/master' into bananasplit
# Conflicts: # keyboards/bananasplit/Makefile # keyboards/bananasplit/bananasplit.c # keyboards/bananasplit/bananasplit.h # keyboards/bananasplit/config.h # keyboards/bananasplit/keymaps/default/keymap.c # keyboards/bananasplit/rules.mk
-rw-r--r--.gitignore5
-rw-r--r--book.json8
-rw-r--r--docs/basic_keycodes.md8
-rw-r--r--docs/documentation_best_practices.md38
-rw-r--r--docs/faq.md110
-rw-r--r--docs/glossary.md143
-rw-r--r--docs/porting_your_keyboard_to_qmk.md2
-rwxr-xr-xkeyboards/amj40/Makefile3
-rwxr-xr-xkeyboards/amj40/amj40.c30
-rwxr-xr-xkeyboards/amj40/amj40.h38
-rwxr-xr-xkeyboards/amj40/config.h94
-rwxr-xr-xkeyboards/amj40/keymaps/default/Makefile27
-rwxr-xr-xkeyboards/amj40/keymaps/default/build.sh42
-rwxr-xr-xkeyboards/amj40/keymaps/default/keymap.c173
-rwxr-xr-xkeyboards/amj40/keymaps/default/readme.md11
-rwxr-xr-xkeyboards/amj40/keymaps/default/updatemerge.sh4
-rwxr-xr-xkeyboards/amj40/keymaps/fabian/Makefile27
-rwxr-xr-xkeyboards/amj40/keymaps/fabian/keymap.c236
-rwxr-xr-xkeyboards/amj40/readme.md35
-rwxr-xr-xkeyboards/amj40/rules.mk66
-rw-r--r--keyboards/bananasplit/Makefile15
-rw-r--r--keyboards/bananasplit/README.md29
-rw-r--r--keyboards/bananasplit/bananasplit.c15
-rw-r--r--keyboards/bananasplit/bananasplit.h130
-rw-r--r--keyboards/bananasplit/config.h124
-rw-r--r--keyboards/bananasplit/keymaps/default/keymap.c86
-rw-r--r--keyboards/bananasplit/keymaps/default/readme.md16
-rw-r--r--keyboards/bananasplit/keymaps/hhkbanana/keymap.c25
-rw-r--r--keyboards/bananasplit/keymaps/nic/keymap.c45
-rw-r--r--keyboards/bananasplit/rules.mk30
-rw-r--r--keyboards/deltasplit75/rules.mk12
-rw-r--r--keyboards/eco/Makefile2
-rw-r--r--keyboards/eco/config.h3
-rw-r--r--keyboards/eco/eco.h4
-rw-r--r--keyboards/eco/readme.md2
-rw-r--r--keyboards/eco/rev2/Makefile3
-rw-r--r--keyboards/eco/rev2/config.h30
-rw-r--r--keyboards/eco/rev2/rev2.c1
-rw-r--r--keyboards/eco/rev2/rev2.h24
-rw-r--r--keyboards/eco/rev2/rules.mk5
-rw-r--r--keyboards/handwired/atreus50/rules.mk12
-rw-r--r--keyboards/handwired/magicforce61/rules.mk12
-rw-r--r--keyboards/handwired/magicforce68/rules.mk12
-rw-r--r--keyboards/handwired/numpad20/rules.mk12
-rw-r--r--keyboards/handwired/ortho5x13/rules.mk12
-rw-r--r--keyboards/lets_split/keymaps/fabian/Makefile9
-rw-r--r--keyboards/lets_split/keymaps/fabian/config.h34
-rw-r--r--keyboards/lets_split/keymaps/fabian/keymap.c221
-rw-r--r--keyboards/lets_split/readme.md4
-rw-r--r--keyboards/lets_split/rules.mk12
-rw-r--r--keyboards/minidox/eeprom-lefthand.eep2
-rw-r--r--keyboards/minidox/eeprom-righthand.eep2
-rw-r--r--keyboards/minidox/keymaps/that_canadian/config.h2
-rw-r--r--keyboards/minidox/keymaps/that_canadian/keymap.c15
-rw-r--r--keyboards/minidox/readme.md4
-rw-r--r--keyboards/nyquist/eeprom-lefthand.eep2
-rw-r--r--keyboards/nyquist/eeprom-righthand.eep2
-rw-r--r--keyboards/nyquist/keymaps/default/Makefile2
-rw-r--r--keyboards/nyquist/keymaps/default/config.h7
-rw-r--r--keyboards/nyquist/keymaps/default/keymap.c4
-rw-r--r--keyboards/nyquist/matrix.c242
-rw-r--r--keyboards/nyquist/readme.md4
-rw-r--r--keyboards/nyquist/rules.mk12
-rw-r--r--keyboards/nyquist/split_util.c2
-rw-r--r--keyboards/orthodox/readme.md2
-rw-r--r--keyboards/orthodox/rules.mk12
-rw-r--r--keyboards/satan/keymaps/poker/keymap.c6
-rw-r--r--keyboards/uk78/Makefile3
-rw-r--r--keyboards/uk78/config.h76
-rw-r--r--keyboards/uk78/keymaps/default/keymap.c119
-rw-r--r--keyboards/uk78/readme.md16
-rw-r--r--keyboards/uk78/rules.mk56
-rw-r--r--keyboards/uk78/uk78.c1
-rw-r--r--keyboards/uk78/uk78.h20
-rw-r--r--keyboards/xd60/keymaps/BASE/keymap.c46
-rw-r--r--keyboards/xd60/keymaps/BASE/readme.md5
-rw-r--r--keyboards/xd60/keymaps/base/keymap.c46
-rw-r--r--keyboards/xd60/keymaps/base/readme.md5
-rw-r--r--keyboards/xd75/keymaps/fabian/Makefile37
-rw-r--r--keyboards/xd75/keymaps/fabian/config.h24
-rw-r--r--keyboards/xd75/keymaps/fabian/keymap.c237
-rw-r--r--readme.md1
-rw-r--r--tmk_core/avr.mk14
83 files changed, 2543 insertions, 526 deletions
diff --git a/.gitignore b/.gitignore
index e40308193c..a1f3ce4719 100644
--- a/.gitignore
+++ b/.gitignore
@@ -41,4 +41,7 @@ util/Win_Check_Output.txt
# ignore image files
*.png
*.jpg
-*.gif \ No newline at end of file
+*.gif
+
+# Do not ignore MiniDox left/right hand eeprom files
+!keyboards/minidox/*.eep \ No newline at end of file
diff --git a/book.json b/book.json
index 887d2a6431..09e1bfd94e 100644
--- a/book.json
+++ b/book.json
@@ -3,12 +3,9 @@
"summary": "_summary.md"
},
"plugins" : [
- "anchors",
"edit-link",
"forkmegithub",
- "git-author",
"hints",
- "numbered-headings",
"page-toc",
"terminal",
"toolbar"
@@ -25,6 +22,11 @@
"page-toc": {
"selector": ".markdown-section h1, .markdown-section h2"
},
+ "terminal": {
+ "copyButtons": true,
+ "fade": false,
+ "style": "flat"
+ },
"toolbar": {
"buttons": [
{
diff --git a/docs/basic_keycodes.md b/docs/basic_keycodes.md
index 2be3ada155..4f84647a2a 100644
--- a/docs/basic_keycodes.md
+++ b/docs/basic_keycodes.md
@@ -51,9 +51,9 @@
|KC_RSHIFT|KC_RSFT|RightShift|
|KC_RALT||RightAlt|
|KC_RGUI||Right GUI(Windows/Apple/Meta key)|
-|KC_LOCKING_CAPS||Locking Caps Lock|
-|KC_LOCKING_NUM||Locking Num Lock|
-|KC_LOCKING_SCROLL||Locking Scroll Lock|
+|KC_LOCKING_CAPS|KC_LCAP|Locking Caps Lock|
+|KC_LOCKING_NUM|KC_LNUM|Locking Num Lock|
+|KC_LOCKING_SCROLL|KC_LSCR|Locking Scroll Lock|
|KC_INT4|KC_HENK|JIS Henken|
|KC_INT5|KC_MHEN|JIS Muhenken|
@@ -183,4 +183,4 @@ Windows and Mac use different key codes for next track and previous track. Make
|KC_MS_WH_RIGHT|KC_WH_R|Mouse Wheel Right|
|KC_MS_ACCEL0|KC_ACL0|Mouse Acceleration 0|
|KC_MS_ACCEL1|KC_ACL1|Mouse Acceleration 1|
-|KC_MS_ACCEL2|KC_ACL2|Mouse Acceleration 2| \ No newline at end of file
+|KC_MS_ACCEL2|KC_ACL2|Mouse Acceleration 2|
diff --git a/docs/documentation_best_practices.md b/docs/documentation_best_practices.md
index 8c5b4795a6..f30793181c 100644
--- a/docs/documentation_best_practices.md
+++ b/docs/documentation_best_practices.md
@@ -22,6 +22,14 @@ Your page should generally have multiple "H1" headings. Only H1 and H2 headings
You can have styled hint blocks drawn around text to draw attention to it.
+```
+{% hint style='info' %}
+This uses `hint style='info'`
+{% endhint %}
+```
+
+### Examples:
+
{% hint style='info' %}
This uses `hint style='info'`
{% endhint %}
@@ -37,3 +45,33 @@ This uses `hint style='danger'`
{% hint style='working' %}
This uses `hint style='working'`
{% endhint %}
+
+# Styled Terminal Blocks
+
+You can present styled terminal blocks by including special tokens inside your text block.
+
+```
+\`\`\`
+**[terminal]
+**[prompt foo@joe]**[path ~]**[delimiter $ ]**[command ./myscript]
+Normal output line. Nothing special here...
+But...
+You can add some colors. What about a warning message?
+**[warning [WARNING] The color depends on the theme. Could look normal too]
+What about an error message?
+**[error [ERROR] This is not the error you are looking for]
+\`\`\`
+```
+
+### Example
+
+```
+**[terminal]
+**[prompt foo@joe]**[path ~]**[delimiter $ ]**[command ./myscript]
+Normal output line. Nothing special here...
+But...
+You can add some colors. What about a warning message?
+**[warning [WARNING] The color depends on the theme. Could look normal too]
+What about an error message?
+**[error [ERROR] This is not the error you are looking for]
+```
diff --git a/docs/faq.md b/docs/faq.md
index d7f2a6f4fd..3287578ac7 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -1,10 +1,16 @@
# Frequently Asked Questions
-## What is QMK?
+## General
+
+### What is QMK?
[QMK](https://github.com/qmk), short for Quantum Mechanical Keyboard, is a group of people building tools for custom keyboards. We started with the [QMK firmware](https://github.com/qmk/qmk_firmware), a heavily modified fork of [TMK](https://github.com/tmk/tmk_keyboard).
-## What Differences Are There Between QMK and TMK?
+### Why the name Quantum?
+
+<!-- FIXME -->
+
+### What Differences Are There Between QMK and TMK?
TMK was originally designed and implemented by [Jun Wako](https://github.com/tmk). QMK started as [Jack Humbert's](https://github.com/jackhumbert) fork of TMK for the Planck. After a while Jack's fork had diverged quite a bit from TMK, and in 2015 Jack decided to rename his fork to QMK.
@@ -14,8 +20,22 @@ From a project and community management standpoint TMK maintains all the officia
Both approaches have their merits and their drawbacks, and code flows freely between TMK and QMK when it makes sense.
-# Debug Console
-## hid_listen can't recognize device
+# Building
+
+## Windows
+
+### I'm on Windows Vista, 7, or 8, how do I setup my build environment?
+
+Follow the build instructions to [install MHV AVR Tools](https://docs.qmk.fm/build_environment_setup.html#windows-vista-and-later).
+
+### I'm on Windows 10 without the Creators Update. Do I have to install it?
+
+No, but if you don't install the creators update you will not be able to build and flash with a single command. You will be able to build but to flash you will have to use a separate program, such as [QMK Flasher](https://github.com/qmk/qmk_flasher).
+
+# Troubleshooting
+
+## Debug Console
+### hid_listen can't recognize device
When debug console of your device is not ready you will see like this:
```
@@ -34,7 +54,7 @@ If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes
You may need privilege to access the device on OS like Linux.
- try `sudo hid_listen`
-## Can't get message on console
+### Can't get message on console
Check:
- *hid_listen* finds your device. See above.
- Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
@@ -42,7 +62,7 @@ Check:
- try using 'print' function instead of debug print. See **common/print.h**.
- disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
-## Linux or UNIX like system requires Super User privilege
+### Linux or UNIX like system requires Super User privilege
Just use 'sudo' to execute *hid_listen* with privilege.
```
$ sudo hid_listen
@@ -56,10 +76,9 @@ File: /etc/udev/rules.d/52-tmk-keyboard.rules(in case of Ubuntu)
SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
```
-***
+## Software Issues
-# Miscellaneous
-## NKRO Doesn't work
+### NKRO Doesn't work
First you have to compile frimware with this build option `NKRO_ENABLE` in **Makefile**.
Try `Magic` **N** command(`LShift+RShift+N` by default) when **NKRO** still doesn't work. You can use this command to toggle between **NKRO** and **6KRO** mode temporarily. In some situations **NKRO** doesn't work you need to switch to **6KRO** mode, in particular when you are in BIOS.
@@ -68,15 +87,7 @@ If your firmeare built with `BOOTMAGIC_ENABLE` you need to turn its switch on by
https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch
-
-## TrackPoint needs reset circuit(PS/2 mouse support)
-Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.
-
-- http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
-- http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
-
-
-## Can't read column of matrix beyond 16
+### Can't read column of matrix beyond 16
Use `1UL<<16` instead of `1<<16` in `read_cols()` in [matrix.h] when your columns goes beyond 16.
In C `1` means one of [int] type which is [16bit] in case of AVR so you can't shift left more than 15. You will get unexpected zero when you say `1<<16`. You have to use [unsigned long] type with `1UL`.
@@ -84,16 +95,16 @@ In C `1` means one of [int] type which is [16bit] in case of AVR so you can't sh
http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
-## Bootloader jump doesn't work
+### Bootloader jump doesn't work
Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.
```
# Size of Bootloaders in bytes:
-# Atmel DFU loader(ATmega32U4) 4096
-# Atmel DFU loader(AT90USB128) 8192
-# LUFA bootloader(ATmega32U4) 4096
-# Arduino Caterina(ATmega32U4) 4096
-# USBaspLoader(ATmega***) 2048
-# Teensy halfKay(ATmega32U4) 512
+# Atmel DFU loader(ATmega32U4) 4096
+# Atmel DFU loader(AT90USB128) 8192
+# LUFA bootloader(ATmega32U4) 4096
+# Arduino Caterina(ATmega32U4) 4096
+# USBaspLoader(ATmega***) 2048
+# Teensy halfKay(ATmega32U4) 512
# Teensy++ halfKay(AT90USB128) 2048
OPT_DEFS += -DBOOTLOADER_SIZE=4096
```
@@ -107,14 +118,14 @@ byte Atmel/LUFA(ATMega32u4) byte Atmel(AT90SUB1286)
| | | |
| | | |
| Application | | Application |
- | | | |
+ | | | |
= = = =
| | 32KB-4KB | | 128KB-8KB
0x6000 +---------------+ 0x1E000 +---------------+
| Bootloader | 4KB | Bootloader | 8KB
0x7FFF +---------------+ 0x1FFFF +---------------+
-
+
byte Teensy(ATMega32u4) byte Teensy++(AT90SUB1286)
0x0000 +---------------+ 0x00000 +---------------+
| | | |
@@ -132,20 +143,28 @@ And see this discussion for further reference.
https://github.com/tmk/tmk_keyboard/issues/179
-## Special Extra key doesn't work(System, Audio control keys)
+### Special Extra key doesn't work(System, Audio control keys)
You need to define `EXTRAKEY_ENABLE` in `rules.mk` to use them in QMK.
```
EXTRAKEY_ENABLE = yes # Audio control and System control
```
-## Wakeup from sleep doesn't work
+### Wakeup from sleep doesn't work
In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting.
Pressing any key during sleep should wake host.
-## Using Arduino?
+## Hardware Issues
+
+### TrackPoint needs reset circuit(PS/2 mouse support)
+Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.
+
+- http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
+- http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
+
+### Using Arduino?
**Note that Arduino pin naming is different from actual chip.** For example, Arduino pin `D0` is not `PD0`. Check circuit with its schematics yourself.
@@ -154,8 +173,7 @@ Pressing any key during sleep should wake host.
Arduino leonardo and micro have **ATMega32U4** and can be used for TMK, though Arduino bootloader may be a problem.
-
-## Using PF4-7 pins of USB AVR?
+### Using PF4-7 pins of USB AVR?
You need to set JTD bit of MCUCR yourself to use PF4-7 as GPIO. Those pins are configured to serve JTAG function by default. MCUs like ATMega*U* or AT90USB* are affeteced with this.
If you are using Teensy this isn't needed. Teensy is shipped with JTAGEN fuse bit unprogrammed to disable the function.
@@ -171,12 +189,7 @@ https://github.com/tmk/tmk_keyboard/blob/master/keyboard/hbkb/matrix.c#L67
And read **26.5.1 MCU Control Register – MCUCR** of ATMega32U4 datasheet.
-## Adding LED indicators of Lock keys
-You need your own LED indicators for CapsLock, ScrollLock and NumLock? See this post.
-
-http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p191560
-
-## Program Arduino Micro/Leonardo
+### Program Arduino Micro/Leonardo
Push reset button and then run command like this within 8 seconds.
```
@@ -188,27 +201,16 @@ Device name will vary depending on your system.
http://arduino.cc/en/Main/ArduinoBoardMicro
https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867
-
-## USB 3 compatibility
-I heard some people have a problem with USB 3 port, try USB 2 port.
-
-
-## Mac compatibility
-### OS X 10.11 and Hub
-https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034
-
-
-## Problem on BIOS(UEFI)/Resume(Sleep&Wake)/Power cycles
+### Problem on BIOS(UEFI)/Resume(Sleep&Wake)/Power cycles
Some people reported their keyboard stops working on BIOS and/or after resume(power cycles).
-As of now root of its cause is not clear but some build options seem to be related. In Makefile try to disable those options like `CONSOLE_ENABLE`, `NKRO_ENABLE`, `SLEEP_LED_ENABLE` and/or others.
+As of now root of its cause is not clear but some build options seem to be related. In Makefile try to disable those options like `CONSOLE_ENABLE`, `NKRO_ENABLE`, `SLEEP_LED_ENABLE` and/or others.
https://github.com/tmk/tmk_keyboard/issues/266
https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778
+## Flashing Problems
+### Can't use dfu-programmer or QMK Flasher to flash on Windows
-## FLIP doesn't work
-### AtLibUsbDfu.dll not found
-Remove current driver and reinstall one FLIP provides from DeviceManager.
-http://imgur.com/a/bnwzy
+Windows requires a driver to support the keyboard in DFU mode. You can use [QMK Driver Installer](https://github.com/qmk/qmk_driver_installer/releases) to install the necessary drivers.
diff --git a/docs/glossary.md b/docs/glossary.md
index fac1952a6d..2fd53ca979 100644
--- a/docs/glossary.md
+++ b/docs/glossary.md
@@ -1,29 +1,170 @@
# Glossary of QMK terms
+## ARM
+A line of 32-bit MCU's produced by a number of companies, such as Atmel, Cypress, Kinetis, NXP, ST, and TI.
+
+## AVR
+A line of 8-bit MCU's produced by [Atmel](http://atmel.com). AVR was the original platform that TMK supported.
+
+## AZERTY
+The standard Français (French) keyboard layout. Named for the first 6 keys on the keyboard.
+
+## Backlight
+A generic term for lighting on a keyboard. The backlight is typically, but not always, an array of LED's that shine through keycaps and/or switches.
+
+## Bluetooth
+A short range peer to peer wireless protocol. Most common wireless protocol for a keyboard.
+
+## Bootloader
+A special program that is written to a protected area of your MCU that allows the MCU to upgrade its own firmware, typically over USB.
+
+## Bootmagic
+A feature that allows for various keyboard behavior changes to happen on the fly, such as swapping or disabling common keys.
+
+## C
+A low-level programming language suitable for system code. Most QMK code is written in C.
+
+## Colemak
+An alternative keyboard layout that i