aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsmiley <smiley@users.noreply.github.com>2021-01-23 23:41:29 +0200
committerGitHub <noreply@github.com>2021-01-23 13:41:29 -0800
commitd6701b3ac7b05dc6f8ce87b525af14932d5c0f27 (patch)
tree1dd1fb65cbbca29dbe0170bddbbfbb12a2d9502f
parent05a4583ce89ae12c8f978fe015ebab387f649575 (diff)
downloadqmk_firmware-d6701b3ac7b05dc6f8ce87b525af14932d5c0f27.tar.gz
qmk_firmware-d6701b3ac7b05dc6f8ce87b525af14932d5c0f27.zip
Fix typos and reword some sentences in FAQs (#11546)
* Fix minor typo in "General FAQ" "want to do brand it with QMK" -> "want to brand it with QMK" * Reword some of "Debugging FAQ" & "Miscellaneous FAQ". Mostly grammatical wording of some parts and missing capitalization
-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 b2d09605b..872b1688e 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:
98Waiting for device:......... 98Waiting for device:.........
99``` 99```
100 100
101once the device is plugged in then *hid_listen* finds it you will get this message: 101Once the device is plugged in then *hid_listen* finds it you will get this message:
102 102
103``` 103```
104Waiting for new device:......................... 104Waiting for new device:.........................
@@ -107,13 +107,12 @@ Listening:
107 107
108If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes` in [Makefile] 108If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes` in [Makefile]
109 109
110You may need privilege to access the device on OS like Linux. 110You may need privileges to access the device an OS like Linux. Try `sudo hid_listen`.
111- try `sudo hid_listen`
112 111
113## Can't Get Message on Console 112## Can't Get Message on Console
114Check: 113Check:
115- *hid_listen* finds your device. See above. 114- *hid_listen* finds your device. See above.
116- Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands). 115- Enable debug by pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
117- set `debug_enable=true`. See [Debugging](#debugging) 116- Set `debug_enable=true`. See [Debugging](#debugging)
118- try using 'print' function instead of debug print. See **common/print.h**. 117- Try using `print` function instead of debug print. See **common/print.h**.
119- disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97). 118- 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 8e9771cbc..56b150da2 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
34 34
35Awesome! Open up a Pull Request for it. We'll review the code, and merge it! 35Awesome! Open up a Pull Request for it. We'll review the code, and merge it!
36 36
37### What if I want to do brand it with `QMK`? 37### What if I want to brand it with `QMK`?
38 38
39That's amazing! We would love to assist you with that! 39That's amazing! We would love to assist you with that!
40 40
diff --git a/docs/faq_misc.md b/docs/faq_misc.md
index 10961fb9f..ac7dd88d0 100644
--- a/docs/faq_misc.md
+++ b/docs/faq_misc.md
@@ -18,8 +18,8 @@ what things are (and likely aren't) too risky.
18- Too large a .hex file is trouble; `make dfu` will erase the block, 18- Too large a .hex file is trouble; `make dfu` will erase the block,
19 test the size (oops, wrong order!), which errors out, failing to 19 test the size (oops, wrong order!), which errors out, failing to
20 flash the keyboard, leaving it in DFU mode. 20 flash the keyboard, leaving it in DFU mode.
21 - To this end, note that the maximum .hex file size on Planck is 21 - To this end, note that the maximum .hex file size on e.g. Planck
22 7000h (28672 decimal) 22 is 7000h (28672 decimal)
23 23
24``` 24```
25Linking: .build/planck_rev4_cbbrowne.elf [OK] 25Linking: .build/planck_rev4_cbbrowne.elf [OK]
@@ -38,24 +38,24 @@ Size after:
38 consume extra memory; watch out for BOOTMAGIC_ENABLE, 38 consume extra memory; watch out for BOOTMAGIC_ENABLE,
39 MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, CONSOLE_ENABLE, API_SYSEX_ENABLE 39 MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, CONSOLE_ENABLE, API_SYSEX_ENABLE
40- DFU tools do /not/ allow you to write into the bootloader (unless 40- DFU tools do /not/ allow you to write into the bootloader (unless
41 you throw in extra fruit salad of options), so there is little risk 41 you throw in an extra fruit salad of options), so there is little risk
42 there. 42 there.
43- EEPROM has around a 100000 write cycle. You shouldn't rewrite the 43- EEPROM has around a 100000 (100k) write cycle. You shouldn't rewrite
44 firmware repeatedly and continually; that'll burn the EEPROM 44 the firmware repeatedly and continually; that'll burn the EEPROM
45 eventually. 45 eventually.
46 46
47## NKRO Doesn't work 47## NKRO Doesn't work
48First you have to compile firmware with this build option `NKRO_ENABLE` in **Makefile**. 48First you have to compile firmware with the build option `NKRO_ENABLE` in **Makefile**.
49 49
50Try `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. 50Try `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.
51 51
52If 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. 52If 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.
53 53
54https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch 54https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch
55 55
56 56
57## TrackPoint Needs Reset Circuit (PS/2 Mouse Support) 57## TrackPoint Needs Reset Circuit (PS/2 Mouse Support)
58Without reset circuit you will have inconsistent result due to improper initialize of the hardware. See circuit schematic of TPM754. 58Without reset circuit you will have inconsistent result due to improper initialization of the hardware. See circuit schematic of TPM754:
59 59
60- http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447 60- http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
61- http://www.mikrocontroller.net/attachment/52583/tpm754.pdf 61- http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
@@ -64,7 +64,7 @@ Without reset circuit you will have inconsistent result due to improper initiali
64## Can't Read Column of Matrix Beyond 16 64## Can't Read Column of Matrix Beyond 16
65Use `1UL<<16` instead of `1<<16` in `read_cols()` in [matrix.h] when your columns goes beyond 16. 65Use `1UL<<16` instead of `1<<16` in `read_cols()` in [matrix.h] when your columns goes beyond 16.
66 66
67In 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`. 67In 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`.
68 68
69http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279 69http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
70 70
@@ -75,11 +75,9 @@ You need to define `EXTRAKEY_ENABLE` in `rules.mk` to use them in QMK.
75EXTRAKEY_ENABLE = yes # Audio control and System control 75EXTRAKEY_ENABLE = yes # Audio control and System control
76``` 76```
77 77
78## Wakeup from Sleep Doesn't Work 78## Wake from Sleep Doesn't Work
79 79
80In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting. 80In 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.
81
82Pressing any key during sleep should wake host.
83 81
84## Using Arduino? 82## Using Arduino?
85 83
@@ -101,18 +99,19 @@ If you would like to keep JTAG enabled, just add the following to your `config.h
101``` 99```
102 100
103## USB 3 Compatibility 101## USB 3 Compatibility
104I heard some people have a problem with USB 3 port, try USB 2 port. 102Some problems can be fixed by switching from a USB 3.x port to a USB 2.0 port.
105 103
106 104
107## Mac Compatibility 105## Mac Compatibility
108### OS X 10.11 and Hub 106### OS X 10.11 and Hub
109https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034 107See here: https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034
110 108
111 109
112## Problem on BIOS (UEFI)/Resume (Sleep & Wake)/Power Cycles 110## Problem in BIOS (UEFI) Setup/Resume (Sleep & Wake)/Power Cycles
113Some people reported their keyboard stops working on BIOS and/or after resume(power cycles). 111Some people reported their keyboard stops working in BIOS and/or after resume(power cycles).
114 112
115As 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. 113As 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.
116 114
117https://github.com/tmk/tmk_keyboard/issues/266 115More info:
118https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778 116- https://github.com/tmk/tmk_keyboard/issues/266
117- https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778