summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-01-23 21:42:03 +0000
committerQMK Bot <hello@qmk.fm>2021-01-23 21:42:03 +0000
commit3f4ff5b6a7ef8e4e58ae84b2e3967a2c8024bf06 (patch)
tree532a801d006a3dda3030d3066c4d17bb8bc9b1f9 /docs
parent1cdea7f53056818fa1e471a8806b9706db8c0c01 (diff)
parentd6701b3ac7b05dc6f8ce87b525af14932d5c0f27 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/faq_debug.md13
-rw-r--r--docs/faq_general.md2
-rw-r--r--docs/faq_misc.md41
3 files changed, 27 insertions, 29 deletions
diff --git a/docs/faq_debug.md b/docs/faq_debug.md
index b2d09605b3..872b1688ed 100644
--- a/docs/faq_debug.md
+++ b/docs/faq_debug.md
@@ -98,7 +98,7 @@ When debug console of your device is not ready you will see like this:
Waiting for device:.........
```
-once the device is plugged in then *hid_listen* finds it you will get this message:
+Once the device is plugged in then *hid_listen* finds it you will get this message:
```
Waiting for new device:.........................
@@ -107,13 +107,12 @@ Listening:
If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes` in [Makefile]
-You may need privilege to access the device on OS like Linux.
-- try `sudo hid_listen`
+You may need privileges to access the device an OS like Linux. Try `sudo hid_listen`.
## 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).
-- set `debug_enable=true`. See [Debugging](#debugging)
-- 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).
+- Enable debug by pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
+- Set `debug_enable=true`. See [Debugging](#debugging)
+- 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).
diff --git a/docs/faq_general.md b/docs/faq_general.md
index 8e9771cbcd..56b150da29 100644
--- a/docs/faq_general.md
+++ b/docs/faq_general.md
@@ -34,7 +34,7 @@ Additionally, you can find additional `git` and GitHub related links [here](newb
Awesome! Open up a Pull Request for it. We'll review the code, and merge it!
-### What if I want to do brand it with `QMK`?
+### What if I want to brand it with `QMK`?
That's amazing! We would love to assist you with that!
diff --git a/docs/faq_misc.md b/docs/faq_misc.md
index 10961fb9f2..ac7dd88d06 100644
--- a/docs/faq_misc.md
+++ b/docs/faq_misc.md
@@ -18,8 +18,8 @@ what things are (and likely aren't) too risky.
- Too large a .hex file is trouble; `make dfu` will erase the block,
test the size (oops, wrong order!), which errors out, failing to
flash the keyboard, leaving it in DFU mode.
- - To this end, note that the maximum .hex file size on Planck is
- 7000h (28672 decimal)
+ - To this end, note that the maximum .hex file size on e.g. Planck
+ is 7000h (28672 decimal)
```
Linking: .build/planck_rev4_cbbrowne.elf [OK]
@@ -38,24 +38,24 @@ Size after:
consume extra memory; watch out for BOOTMAGIC_ENABLE,
MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, CONSOLE_ENABLE, API_SYSEX_ENABLE
- DFU tools do /not/ allow you to write into the bootloader (unless
- you throw in extra fruit salad of options), so there is little risk
+ you throw in an extra fruit salad of options), so there is little risk
there.
-- EEPROM has around a 100000 write cycle. You shouldn't rewrite the
- firmware repeatedly and continually; that'll burn the EEPROM
+- EEPROM has around a 100000 (100k) write cycle. You shouldn't rewrite
+ the firmware repeatedly and continually; that'll burn the EEPROM
eventually.
## NKRO Doesn't work
-First you have to compile firmware with this build option `NKRO_ENABLE` in **Makefile**.
+First you have to compile firmware with the 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.
+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 and you will need to switch to **6KRO** mode, in particular when you are in BIOS.
-If your firmware built with `BOOTMAGIC_ENABLE` you need to turn its switch on by `BootMagic` **N** command(`Space+N` by default). This setting is stored in EEPROM and kept over power cycles.
+If your firmware was built with `BOOTMAGIC_ENABLE` you need to turn its switch on by `BootMagic` **N** command(`Space+N` by default). This setting is stored in EEPROM and kept over power cycles.
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 result due to improper initialize of the hardware. See circuit schematic of TPM754.
+Without reset circuit you will have inconsistent result due to improper initialization 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
@@ -64,7 +64,7 @@ Without reset circuit you will have inconsistent result due to improper initiali
## 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 [16 bit] 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`.
+In C `1` means one of [int] type which is [16 bit] in case of AVR, so you can't shift left more than 15. Thus, calculating `1<<16` will unexpectedly equal zero. To work around this, you have to use [unsigned long] type with `1UL`.
http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
@@ -75,11 +75,9 @@ 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
+## Wake 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.
+In Windows check `Allow this device to wake the computer` setting in **Power Management** property tab of **Device Manager**. Also check your BIOS settings. Pressing any key during sleep should wake host.
## Using Arduino?
@@ -101,18 +99,19 @@ If you would like to keep JTAG enabled, just add the following to your `config.h
```
## USB 3 Compatibility
-I heard some people have a problem with USB 3 port, try USB 2 port.
+Some problems can be fixed by switching from a USB 3.x port to a USB 2.0 port.
## Mac Compatibility
### OS X 10.11 and Hub
-https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034
+See here: https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034
-## Problem on BIOS (UEFI)/Resume (Sleep & Wake)/Power Cycles
-Some people reported their keyboard stops working on BIOS and/or after resume(power cycles).
+## Problem in BIOS (UEFI) Setup/Resume (Sleep & Wake)/Power Cycles
+Some people reported their keyboard stops working in 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 the root cause is not clear, but some build options seem to be related. In Makefile, try to disable 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
+More info:
+- https://github.com/tmk/tmk_keyboard/issues/266
+- https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778