diff options
author | Brian Choromanski <BrianChoromanski@gmail.com> | 2018-03-01 10:45:47 -0500 |
---|---|---|
committer | skullydazed <skullydazed@users.noreply.github.com> | 2018-03-01 07:45:47 -0800 |
commit | 7f7f763598b7be7b2081a73be2124f40349d8032 (patch) | |
tree | 2e89e3fb645567b5605d396abd13cf519d012bf9 | |
parent | 2b8a82fb9defa95ca679672322e7f43052fdc44f (diff) | |
download | qmk_firmware-7f7f763598b7be7b2081a73be2124f40349d8032.tar.gz qmk_firmware-7f7f763598b7be7b2081a73be2124f40349d8032.zip |
Fixed dead links (#2451)
* Fixed typo of 'confid.h' to 'config.h'
* Fixed broken links in docs
* Fixed a lot of dead links
43 files changed, 57 insertions, 62 deletions
diff --git a/docs/feature_mouse_keys.md b/docs/feature_mouse_keys.md index 9e7df929e..673eafaef 100644 --- a/docs/feature_mouse_keys.md +++ b/docs/feature_mouse_keys.md | |||
@@ -40,7 +40,7 @@ You can use these keycodes within your keymap to map button presses to mouse act | |||
40 | |`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1| | 40 | |`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1| |
41 | |`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2| | 41 | |`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2| |
42 | 42 | ||
43 | You can see an example in the `_ML` here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/keymap.c#L46 | 43 | You can see an example in the `_ML` here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/66/keymaps/mouse_keys/keymap.c#L46 |
44 | 44 | ||
45 | ## Configuring the Behavior of Mousekeys | 45 | ## Configuring the Behavior of Mousekeys |
46 | 46 | ||
diff --git a/docs/glossary.md b/docs/glossary.md index c8c54d6de..754c1469e 100644 --- a/docs/glossary.md +++ b/docs/glossary.md | |||
@@ -4,7 +4,7 @@ | |||
4 | A line of 32-bit MCU's produced by a number of companies, such as Atmel, Cypress, Kinetis, NXP, ST, and TI. | 4 | A line of 32-bit MCU's produced by a number of companies, such as Atmel, Cypress, Kinetis, NXP, ST, and TI. |
5 | 5 | ||
6 | ## AVR | 6 | ## AVR |
7 | A line of 8-bit MCU's produced by [Atmel](http://atmel.com). AVR was the original platform that TMK supported. | 7 | A line of 8-bit MCU's produced by [Atmel](http://www.microchip.com/). AVR was the original platform that TMK supported. |
8 | 8 | ||
9 | ## AZERTY | 9 | ## AZERTY |
10 | The standard Français (French) keyboard layout. Named for the first 6 keys on the keyboard. | 10 | The standard Français (French) keyboard layout. Named for the first 6 keys on the keyboard. |
diff --git a/docs/understanding_qmk.md b/docs/understanding_qmk.md index 13b6e2ef6..4544cb260 100644 --- a/docs/understanding_qmk.md +++ b/docs/understanding_qmk.md | |||
@@ -77,7 +77,7 @@ At the keyboard level we define a C macro (typically named `KEYMAP()`) which map | |||
77 | 77 | ||
78 | Notice how the second block of our `KEYMAP()` macro matches the Matrix Scanning array above? This macro is what will map the matrix scanning array to keycodes. However, if you look at a 17 key numpad you'll notice that it has 3 places where the matrix could have a switch but doesn't, due to larger keys. We have populated those spaces with `KC_NO` so that our keymap definition doesn't have to. | 78 | Notice how the second block of our `KEYMAP()` macro matches the Matrix Scanning array above? This macro is what will map the matrix scanning array to keycodes. However, if you look at a 17 key numpad you'll notice that it has 3 places where the matrix could have a switch but doesn't, due to larger keys. We have populated those spaces with `KC_NO` so that our keymap definition doesn't have to. |
79 | 79 | ||
80 | You can also use this macro to handle unusual matrix layouts, for example the [Clueboard rev 2](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/rev2/rev2.h). Explaining that is outside the scope of this document. | 80 | You can also use this macro to handle unusual matrix layouts, for example the [Clueboard rev 2](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/66/rev2/rev2.h). Explaining that is outside the scope of this document. |
81 | 81 | ||
82 | ##### Keycode Assignment | 82 | ##### Keycode Assignment |
83 | 83 | ||
@@ -135,8 +135,8 @@ The `process_record()` function itself is deceptively simple, but hidden within | |||
135 | * [`void process_record(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/action.c#L128) | 135 | * [`void process_record(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/action.c#L128) |
136 | * [`bool process_record_quantum(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L140) | 136 | * [`bool process_record_quantum(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L140) |
137 | * [Map this record to a keycode](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L143) | 137 | * [Map this record to a keycode](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L143) |
138 | * [`bool process_record_kb(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/cluecard/cluecard.c#L20) | 138 | * [`bool process_record_kb(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/card/card.c#L20) |
139 | * [`bool process_record_user(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/cluecard/keymaps/default/keymap.c#L58) | 139 | * [`bool process_record_user(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/card/keymaps/default/keymap.c#L58) |
140 | * [`bool process_midi(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_midi.c#L102) | 140 | * [`bool process_midi(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_midi.c#L102) |
141 | * [`bool process_audio(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_audio.c#L10) | 141 | * [`bool process_audio(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_audio.c#L10) |
142 | * [`bool process_music(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_music.c#L69) | 142 | * [`bool process_music(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_music.c#L69) |
diff --git a/keyboards/crawlpad/readme.md b/keyboards/crawlpad/readme.md index 98d04bfad..0bdc0f172 100644 --- a/keyboards/crawlpad/readme.md +++ b/keyboards/crawlpad/readme.md | |||
@@ -14,4 +14,4 @@ Make example for this keyboard (after setting up your build environment): | |||
14 | 14 | ||
15 | See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. | 15 | See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. |
16 | 16 | ||
17 | For those that prefer a GUI tool, the crawlpad.json file in this repo can be used on [kbfirmware.com](http://kbfirmware.com]. \ No newline at end of file | 17 | For those that prefer a GUI tool, the crawlpad.json file in this repo can be used on [kbfirmware.com](http://kbfirmware.com). \ No newline at end of file |
diff --git a/keyboards/ergodox_ez/keymaps/bepo_tm_style/readme.md b/keyboards/ergodox_ez/keymaps/bepo_tm_style/readme.md index d24e66c86..5571f120c 100755 --- a/keyboards/ergodox_ez/keymaps/bepo_tm_style/readme.md +++ b/keyboards/ergodox_ez/keymaps/bepo_tm_style/readme.md | |||
@@ -19,4 +19,4 @@ make ergodox_ez:bepo_tm_style:all | |||
19 | ## Debug | 19 | ## Debug |
20 | 20 | ||
21 | See https://github.com/tmk/tmk_keyboard#magic-commands for command that can help | 21 | See https://github.com/tmk/tmk_keyboard#magic-commands for command that can help |
22 | debug, together with the hid_listen tool (https://docs.qmk.fm/faq_debug.html). \ No newline at end of file | 22 | debug, together with the [hid_listen tool](https://docs.qmk.fm/faq_debug.html). \ No newline at end of file |
diff --git a/keyboards/fc980c/README.md b/keyboards/fc980c/README.md index 10d84a096..16ad9021c 100644 --- a/keyboards/fc980c/README.md +++ b/keyboards/fc980c/README.md | |||
@@ -155,8 +155,8 @@ Datasheets | |||
155 | - AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf | 155 | - AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf |
156 | - JST S5B-PH-SM4: http://www.jst-mfg.com/product/pdf/eng/ePH.pdf | 156 | - JST S5B-PH-SM4: http://www.jst-mfg.com/product/pdf/eng/ePH.pdf |
157 | - Hirose UX60SC-MB-5S8: https://www.hirose.com/product/en/products/UX/UX60SC-MB-5S8%2880%29/ | 157 | - Hirose UX60SC-MB-5S8: https://www.hirose.com/product/en/products/UX/UX60SC-MB-5S8%2880%29/ |
158 | - TYU TU1252WNR-05S: http://php2.twinner.com.tw/files/tyu/TU1252series.pdf | ||
159 | - Tr(E42) for LED?: http://cj-elec.com/txUpfile/2013614923661845.pdf | 158 | - Tr(E42) for LED?: http://cj-elec.com/txUpfile/2013614923661845.pdf |
159 | - TYU TU1252WNR-05S: http://php2.twinner.com.tw/files/goodjob/TY1252series.pdf | ||
160 | 160 | ||
161 | 161 | ||
162 | 3.3V power supply | 162 | 3.3V power supply |
diff --git a/keyboards/handwired/CMD60/README.md b/keyboards/handwired/CMD60/README.md index 83e371543..8b0dd109f 100644 --- a/keyboards/handwired/CMD60/README.md +++ b/keyboards/handwired/CMD60/README.md | |||
@@ -10,7 +10,7 @@ achieve a higher level of productivity if you take the time to learn its functio | |||
10 | 10 | ||
11 | ## Quantum MK Firmware | 11 | ## Quantum MK Firmware |
12 | 12 | ||
13 | For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). | 13 | For the full Quantum feature list, see [the parent readme.md](/docs/README.md). |
14 | 14 | ||
15 | ## Building | 15 | ## Building |
16 | 16 | ||
diff --git a/keyboards/handwired/fivethirteen/README.md b/keyboards/handwired/fivethirteen/README.md index b2e13cd6d..a965650fc 100644 --- a/keyboards/handwired/fivethirteen/README.md +++ b/keyboards/handwired/fivethirteen/README.md | |||
@@ -3,7 +3,7 @@ fivethirteen keyboard firmware | |||
3 | 3 | ||
4 | ## Quantum MK Firmware | 4 | ## Quantum MK Firmware |
5 | 5 | ||
6 | For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). | 6 | For the full Quantum feature list, see [the parent readme.md](/doc/README.md). |
7 | 7 | ||
8 | ## Building | 8 | ## Building |
9 | 9 | ||
diff --git a/keyboards/handwired/gamenum/README.md b/keyboards/handwired/gamenum/README.md index 5b53004ef..bf8045be1 100644 --- a/keyboards/handwired/gamenum/README.md +++ b/keyboards/handwired/gamenum/README.md | |||
@@ -76,7 +76,7 @@ This is the code for the KC_FN1 button. Notice how we check against what key is | |||
76 | 76 | ||
77 | ## Quantum MK Firmware | 77 | ## Quantum MK Firmware |
78 | 78 | ||
79 | For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). | 79 | For the full Quantum feature list, see [the parent readme.md](/docs/README.md). |
80 | 80 | ||
81 | ## Building | 81 | ## Building |
82 | 82 | ||
diff --git a/keyboards/handwired/minorca/readme.md b/keyboards/handwired/minorca/readme.md index 93c767954..0253506e0 100644 --- a/keyboards/handwired/minorca/readme.md +++ b/keyboards/handwired/minorca/readme.md | |||
@@ -30,4 +30,4 @@ Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` fol | |||
30 | - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck) | 30 | - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck) |
31 | - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c) | 31 | - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c) |
32 | - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck) | 32 | - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck) |
33 | - [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid) | 33 | - [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck) |
diff --git a/keyboards/handwired/reddot/readme.md b/keyboards/handwired/reddot/readme.md index 11bcba54a..8cdbb47d6 100755 --- a/keyboards/handwired/reddot/readme.md +++ b/keyboards/handwired/reddot/readme.md | |||
@@ -3,7 +3,7 @@ | |||
3 | 3 | ||
4 | ## Quantum MK Firmware | 4 | ## Quantum MK Firmware |
5 | 5 | ||
6 | For the full Quantum feature list, see [the parent README.md](/README.md). | 6 | For the full Quantum feature list, see [the parent README.md](/readme.md). |
7 | 7 | ||
8 | ## Building | 8 | ## Building |
9 | 9 | ||
diff --git a/keyboards/handwired/traveller/readme.md b/keyboards/handwired/traveller/readme.md index 646844b1d..0be53a962 100644 --- a/keyboards/handwired/traveller/readme.md +++ b/keyboards/handwired/traveller/readme.md | |||
@@ -14,7 +14,7 @@ You can make your own traveller keyboard by using the openscad tools from the a | |||
14 | 14 | ||
15 | ## Quantum MK Firmware | 15 | ## Quantum MK Firmware |
16 | 16 | ||
17 | For the full Quantum feature list, see [the parent README.md](/README.md). | 17 | For the full Quantum feature list, see [the parent README.md](/readme.md). |
18 | 18 | ||
19 | ## Building | 19 | ## Building |
20 | 20 | ||
diff --git a/keyboards/jd40/readme.md b/keyboards/jd40/readme.md index 6934e54d4..c5ab42ed0 100644 --- a/keyboards/jd40/readme.md +++ b/keyboards/jd40/readme.md | |||
@@ -5,7 +5,7 @@ A compact 40% keyboard. | |||
5 | 5 | ||
6 | Keyboard Maintainer: QMK Community | 6 | Keyboard Maintainer: QMK Community |
7 | Hardware Supported: JD40 PCB | 7 | Hardware Supported: JD40 PCB |
8 | Hardware Availability: [1up](https://1upkeyboards.com/jd40-mkii-1up-keyboards-logo-pcb.html) [mechanicalkeyboards.com](https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=2452) [originative](https://originative.co/products/jd40-pcb) | 8 | Hardware Availability: [1up](https://1upkeyboards.com/jd40-mkii-1up-keyboards-logo-pcb.html) [mechanicalkeyboards.com](https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=2452) [originative](https://www.originativeco.com/products/jd40-pcb) |
9 | 9 | ||
10 | Make example for this keyboard (after setting up your build environment): | 10 | Make example for this keyboard (after setting up your build environment): |
11 | 11 | ||
diff --git a/keyboards/kinesis/alvicstep/readme.md b/keyboards/kinesis/alvicstep/readme.md index 974e42e50..810a7aba1 100644 --- a/keyboards/kinesis/alvicstep/readme.md +++ b/keyboards/kinesis/alvicstep/readme.md | |||
@@ -23,7 +23,7 @@ Not yet implemented: | |||
23 | 23 | ||
24 | ## Quantum MK Firmware | 24 | ## Quantum MK Firmware |
25 | 25 | ||
26 | For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). | 26 | For the full Quantum feature list, see [the parent readme.md](/docs/README.md). |
27 | 27 | ||
28 | ## Building | 28 | ## Building |
29 | 29 | ||
diff --git a/keyboards/kinesis/stapelberg/readme.md b/keyboards/kinesis/stapelberg/readme.md index 1a408a15f..0dcb7c283 100644 --- a/keyboards/kinesis/stapelberg/readme.md +++ b/keyboards/kinesis/stapelberg/readme.md | |||
@@ -26,18 +26,18 @@ If you want to perform this customization, these parts may be helpful. | |||
26 | | Reset cables | 2 | Sparkfun | PRT-09140 | | 26 | | Reset cables | 2 | Sparkfun | PRT-09140 | |
27 | 27 | ||
28 | The board and connections are shown here | 28 | The board and connections are shown here |
29 |  | 29 |  |
30 | 30 | ||
31 | The Teensy mounting detail can be seen here. | 31 | The Teensy mounting detail can be seen here. |
32 | I used a socket for prototyping. | 32 | I used a socket for prototyping. |
33 |  | 33 |  |
34 | 34 | ||
35 | 35 | ||
36 | Since the proper mounting of the Teensy board places the reset button in a tight space, I added a 2-pin header to the reset and ground pins on the edge of the board. | 36 | Since the proper mounting of the Teensy board places the reset button in a tight space, I added a 2-pin header to the reset and ground pins on the edge of the board. |
37 | Shorting these two pins together will reset the board. | 37 | Shorting these two pins together will reset the board. |
38 | I also put female to male header jumper cables on these so they could be accessed outside the enclosure. | 38 | I also put female to male header jumper cables on these so they could be accessed outside the enclosure. |
39 | The exterior cables can be seen here. | 39 | The exterior cables can be seen here. |
40 |  | 40 |  |
41 | 41 | ||
42 | 42 | ||
43 | ## Keymaps | 43 | ## Keymaps |
@@ -52,7 +52,3 @@ To build with the default keymap, run `make default` while in the | |||
52 | This keymap contains a dvorak implementation as well as media and symbol layers. | 52 | This keymap contains a dvorak implementation as well as media and symbol layers. |
53 | 53 | ||
54 | Run `make dvorak` while in the `kinesis_stapelberg` working directory. | 54 | Run `make dvorak` while in the `kinesis_stapelberg` working directory. |
55 | |||
56 |  | ||
57 |  | ||
58 |  \ No newline at end of file | ||
diff --git a/keyboards/kmac/readme.md b/keyboards/kmac/readme.md index e7d97778f..fccf902ca 100644 --- a/keyboards/kmac/readme.md +++ b/keyboards/kmac/readme.md | |||
@@ -33,7 +33,7 @@ A [keymap](keymaps/winkeyless) for the winkeyless version of the PCB are also pr | |||
33 | 33 | ||
34 | ### Custom keymaps | 34 | ### Custom keymaps |
35 | 35 | ||
36 | To define your own keymap, copy one of the [existing keymap](keymaps) folders and give it the name of your keymap. Then check the [keymap documentation](https://docs.qmk.fm/Keymap.html) for details on how to modify the keymap. | 36 | To define your own keymap, copy one of the [existing keymap](keymaps) folders and give it the name of your keymap. Then check the [keymap documentation](https://docs.qmk.fm/faq_keymap.html) for details on how to modify the keymap. |
37 | 37 | ||
38 | To make it easy to define keymaps for the different versions of the PCB two macros are provided. | 38 | To make it easy to define keymaps for the different versions of the PCB two macros are provided. |
39 | 39 | ||
diff --git a/keyboards/lets_split/readme.md b/keyboards/lets_split/readme.md index 155f69f15..80fe08b93 100644 --- a/keyboards/lets_split/readme.md +++ b/keyboards/lets_split/readme.md | |||
@@ -44,7 +44,7 @@ If everything worked correctly you will see a file: | |||
44 | lets_split_rev2_YOUR_KEYMAP_NAME.hex | 44 | lets_split_rev2_YOUR_KEYMAP_NAME.hex |
45 | ``` | 45 | ``` |
46 | 46 | ||
47 | For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md. | 47 | For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/docs/faq_keymap.md) in the main readme.md. |
48 | 48 | ||
49 | ### Let's split 1.0 | 49 | ### Let's split 1.0 |
50 | If you have a first generation Let's Split you will need to use the revision 1 code. To do so, use `rev1` in all your commands instead. | 50 | If you have a first generation Let's Split you will need to use the revision 1 code. To do so, use `rev1` in all your commands instead. |
diff --git a/keyboards/lfkeyboards/lfkpad/readme.md b/keyboards/lfkeyboards/lfkpad/readme.md index 5f23d988a..7dd8337e8 100644 --- a/keyboards/lfkeyboards/lfkpad/readme.md +++ b/keyboards/lfkeyboards/lfkpad/readme.md | |||
@@ -3,7 +3,7 @@ bluepad keyboard firmware | |||
3 | 3 | ||
4 | ## Quantum MK Firmware | 4 | ## Quantum MK Firmware |
5 | 5 | ||
6 | For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). | 6 | For the full Quantum feature list, see [the parent readme.md](/docs/README.md). |
7 | 7 | ||
8 | ## Building | 8 | ## Building |
9 | 9 | ||
diff --git a/keyboards/mitosis/readme.md b/keyboards/mitosis/readme.md index 3cbdbae61..0d5a74a1d 100644 --- a/keyboards/mitosis/readme.md +++ b/keyboards/mitosis/readme.md | |||
@@ -3,7 +3,7 @@ Mitosis | |||
3 | 3 | ||
4 | A wireless split compact keyboard. | 4 | A wireless split compact keyboard. |
5 | 5 | ||
6 | Keyboard Maintainer: [@reversebias](https://github.com/reversebias] | 6 | Keyboard Maintainer: [@reversebias](https://github.com/reversebias) |
7 | Hardware Supported: Mitosis PCB | 7 | Hardware Supported: Mitosis PCB |
8 | Hardware Availability: https://www.reddit.com/r/MechanicalKeyboards/comments/66588f/wireless_split_qmk_mitosis/ | 8 | Hardware Availability: https://www.reddit.com/r/MechanicalKeyboards/comments/66588f/wireless_split_qmk_mitosis/ |
9 | 9 | ||
diff --git a/keyboards/nyquist/keymaps/333fred/README.md b/keyboards/nyquist/keymaps/333fred/README.md index aa783af07..fa354bb4d 100644 --- a/keyboards/nyquist/keymaps/333fred/README.md +++ b/keyboards/nyquist/keymaps/333fred/README.md | |||
@@ -1,6 +1,6 @@ | |||
1 | # 333fred's Nyquist Layout | 1 | # 333fred's Nyquist Layout |
2 | 2 | ||
3 | This nyquist layout is based on my Ergodox Infinity Layout, which is [here](../../../ergodox/keymaps/333fred/README.md). It doesn't have all of my VS extensions, as I have my nyquist at home, not at work. | 3 | This nyquist layout is based on my Ergodox Infinity Layout, which is [here](../../../../layouts/community/ergodox/333fred/README.md). It doesn't have all of my VS extensions, as I have my nyquist at home, not at work. |
4 | 4 | ||
5 | ## Layers | 5 | ## Layers |
6 | 6 | ||
diff --git a/keyboards/planck/keymaps/grahampheath/readme.md b/keyboards/planck/keymaps/grahampheath/readme.md index ec8020f18..507120c6f 100644 --- a/keyboards/planck/keymaps/grahampheath/readme.md +++ b/keyboards/planck/keymaps/grahampheath/readme.md | |||
@@ -1,4 +1,4 @@ | |||
1 | # Graham's Planck | 1 | # Graham's Planck |
2 | 2 | ||
3 | ## Sounds | 3 | ## Sounds |
4 | I've added a [8ohm 0.5W speaker](http://a.co/6MIKZSy), its a bit large, but it fits in approximately the same space as the ProMicro. I soldered to the pcb hole labeled PC6 on my Rev 3 Planck PCB, and GND on the near by chip. [Pic of an identical mod][https://i1.sndcdn.com/artworks-000128070066-myh0ls-t500x500.jpg] (not mine). | 4 | I've added a [8ohm 0.5W speaker](http://a.co/6MIKZSy), its a bit large, but it fits in approximately the same space as the ProMicro. I soldered to the pcb hole labeled PC6 on my Rev 3 Planck PCB, and GND on the near by chip. [Pic of an identical mod](https://i1.sndcdn.com/artworks-000128070066-myh0ls-t500x500.jpg) (not mine). |
diff --git a/keyboards/readme.md b/keyboards/readme.md index 35900f611..5ba98c6c4 100644 --- a/keyboards/readme.md +++ b/keyboards/readme.md | |||
@@ -53,7 +53,7 @@ These keyboards are part of the QMK repository, but their manufacturers are not | |||
53 | * [Lets Split](/keyboards/lets_split) - Split ortholinear 40% keyboard. | 53 | * [Lets Split](/keyboards/lets_split) - Split ortholinear 40% keyboard. |
54 | * [Phantom](/keyboards/phantom) — A tenkeyless kit by Teel, also from Geekhack. | 54 | * [Phantom](/keyboards/phantom) — A tenkeyless kit by Teel, also from Geekhack. |
55 | * [Retro Refit](/keyboards/retro_refit) — Another creation by IBNobody. | 55 | * [Retro Refit](/keyboards/retro_refit) — Another creation by IBNobody. |
56 | * [S60-x](/keyboards/s60-x) — DIY compact keyboard designed by VinnyCordeiro for Sentraq. | 56 | * [S60-x](/keyboards/s60_x) — DIY compact keyboard designed by VinnyCordeiro for Sentraq. |
57 | * [Satan](/keyboards/satan) — A GH60 variant. | 57 | * [Satan](/keyboards/satan) — A GH60 variant. |
58 | * [SixKeyBoard](/keyboards/sixkeyboard) — A 6-key keyboard made by TechKeys. | 58 | * [SixKeyBoard](/keyboards/sixkeyboard) — A 6-key keyboard made by TechKeys. |
59 | * [TheVan 44](/keyboards/tv44) — A 44-key staggered keybard by Evangs. | 59 | * [TheVan 44](/keyboards/tv44) — A 44-key staggered keybard by Evangs. |
diff --git a/keyboards/roadkit/readme.md b/keyboards/roadkit/readme.md index fbc40a50f..245d5242a 100644 --- a/keyboards/roadkit/readme.md +++ b/keyboards/roadkit/readme.md | |||
@@ -5,7 +5,7 @@ A programmable macro pad. | |||
5 | 5 | ||
6 | Keyboard Maintainer: QMK Community | 6 | Keyboard Maintainer: QMK Community |
7 | Hardware Supported: Roadkit PCB | 7 | Hardware Supported: Roadkit PCB |
8 | Hardware Availability: https://thevankeyboards.com/products/roadkit-r2?variant=37353813966 | 8 | Hardware Availability: https://thevankeyboards.com/collections/catalog/products/road-kit-diy?variant=603645345806 |
9 | 9 | ||
10 | Make example for this keyboard (after setting up your build environment): | 10 | Make example for this keyboard (after setting up your build environment): |
11 | 11 | ||
diff --git a/keyboards/s60_x/keymaps/custom/readme.md b/keyboards/s60_x/keymaps/custom/readme.md index cf87bd915..fd79d5360 100644 --- a/keyboards/s60_x/keymaps/custom/readme.md +++ b/keyboards/s60_x/keymaps/custom/readme.md | |||
@@ -1,5 +1,5 @@ | |||
1 | ### 8 Custom | 1 | ### 8 Custom |
2 | The custom keymap - [keymap_custom.c](keymap_custom.c) - is where I tested all the switches, not being concerned with a specific layout or layers. It's a plain layout option with the extra keys used on ISO & HHKB layouts being assigned some other keys. | 2 | The custom keymap - [keymap.c](keymap.c) - is where I tested all the switches, not being concerned with a specific layout or layers. It's a plain layout option with the extra keys used on ISO & HHKB layouts being assigned some other keys. |
3 | 3 | ||
4 | #### 8.0 Default layer | 4 | #### 8.0 Default layer |
5 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ | 5 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ |
diff --git a/keyboards/s60_x/keymaps/hasu/readme.md b/keyboards/s60_x/keymaps/hasu/readme.md index 64969b616..b79d0e97a 100644 --- a/keyboards/s60_x/keymaps/hasu/readme.md +++ b/keyboards/s60_x/keymaps/hasu/readme.md | |||
@@ -1,4 +1,4 @@ | |||
1 | ### 5. Hasu | 1 | ### 5. Hasu |
2 | This is Hasu's favorite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail. | 2 | This is Hasu's favorite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [keymap.c](keymap.c) for detail. |
3 | 3 | ||
4 | (Hasu is the initial creator of the TMK firmware, in case you weren't aware.) \ No newline at end of file | 4 | (Hasu is the initial creator of the TMK firmware, in case you weren't aware.) \ No newline at end of file |
diff --git a/keyboards/s60_x/keymaps/hhkb/readme.md b/keyboards/s60_x/keymaps/hhkb/readme.md index 2bceb26dd..c7dcec899 100644 --- a/keyboards/s60_x/keymaps/hhkb/readme.md +++ b/keyboards/s60_x/keymaps/hhkb/readme.md | |||
@@ -1,5 +1,5 @@ | |||
1 | ### 7. HHKB | 1 | ### 7. HHKB |
2 | [keymap_hhkb.c](keymap_hhkb.c) emulates original HHKB layers. | 2 | [keymap.c](keymap.c) emulates original HHKB layers. |
3 | #### 7.0: Default layer | 3 | #### 7.0: Default layer |
4 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ | 4 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ |
5 | │ Esc │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │ \ │ ` │ | 5 | │ Esc │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │ \ │ ` │ |
diff --git a/keyboards/s60_x/keymaps/plain/readme.md b/keyboards/s60_x/keymaps/plain/readme.md index ab13323e3..02f524495 100644 --- a/keyboards/s60_x/keymaps/plain/readme.md +++ b/keyboards/s60_x/keymaps/plain/readme.md | |||
@@ -1,6 +1,6 @@ | |||
1 | ### 4. Plain | 1 | ### 4. Plain |
2 | Without any Fn layer this will be useful if you want to use key remapping tool like AHK on host. | 2 | Without any Fn layer this will be useful if you want to use key remapping tool like AHK on host. |
3 | See [keymap_plain.c](keymap_plain.c) for detail. | 3 | See [keymap.c](keymap.c) for detail. |
4 | 4 | ||
5 | #### 4.0 Plain Default layer | 5 | #### 4.0 Plain Default layer |
6 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ | 6 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ |
diff --git a/keyboards/s60_x/keymaps/poker/readme.md b/keyboards/s60_x/keymaps/poker/readme.md index 0d8be9d0f..04d2b78be 100644 --- a/keyboards/s60_x/keymaps/poker/readme.md +++ b/keyboards/s60_x/keymaps/poker/readme.md | |||
@@ -1,6 +1,6 @@ | |||
1 | ### 3 Poker | 1 | ### 3 Poker |
2 | [keymap_poker.c](keymap_poker.c) emulates original Poker layers | 2 | [keymap_poker](../poker/readme.md) emulates original Poker layers |
3 | while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys. | 3 | while both [keymap_poker_bit](../poker_bit/readme.md) and [keymap_poker_set](../poker_set/readme.md) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys. |
4 | 4 | ||
5 | Fn + Esc = ` | 5 | Fn + Esc = ` |
6 | Fn + {left, down, up, right} = {home, pgdown, pgup, end} | 6 | Fn + {left, down, up, right} = {home, pgdown, pgup, end} |
diff --git a/keyboards/s60_x/keymaps/poker_bit/readme.md b/keyboards/s60_x/keymaps/poker_bit/readme.md index 0d8be9d0f..04d2b78be 100644 --- a/keyboards/s60_x/keymaps/poker_bit/readme.md +++ b/keyboards/s60_x/keymaps/poker_bit/readme.md | |||
@@ -1,6 +1,6 @@ | |||
1 | ### 3 Poker | 1 | ### 3 Poker |
2 | [keymap_poker.c](keymap_poker.c) emulates original Poker layers | 2 | [keymap_poker](../poker/readme.md) emulates original Poker layers |
3 | while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys. | 3 | while both [keymap_poker_bit](../poker_bit/readme.md) and [keymap_poker_set](../poker_set/readme.md) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys. |
4 | 4 | ||
5 | Fn + Esc = ` | 5 | Fn + Esc = ` |
6 | Fn + {left, down, up, right} = {home, pgdown, pgup, end} | 6 | Fn + {left, down, up, right} = {home, pgdown, pgup, end} |
diff --git a/keyboards/s60_x/keymaps/poker_set/readme.md b/keyboards/s60_x/keymaps/poker_set/readme.md index 0d8be9d0f..04d2b78be 100644 --- a/keyboards/s60_x/keymaps/poker_set/readme.md +++ b/keyboards/s60_x/keymaps/poker_set/readme.md | |||
@@ -1,6 +1,6 @@ | |||
1 | ### 3 Poker | 1 | ### 3 Poker |
2 | [keymap_poker.c](keymap_poker.c) emulates original Poker layers | 2 | [keymap_poker](../poker/readme.md) emulates original Poker layers |
3 | while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys. | 3 | while both [keymap_poker_bit](../poker_bit/readme.md) and [keymap_poker_set](../poker_set/readme.md) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys. |
4 | 4 | ||
5 | Fn + Esc = ` | 5 | Fn + Esc = ` |
6 | Fn + {left, down, up, right} = {home, pgdown, pgup, end} | 6 | Fn + {left, down, up, right} = {home, pgdown, pgup, end} |
diff --git a/keyboards/s60_x/keymaps/spacefn/readme.md b/keyboards/s60_x/keymaps/spacefn/readme.md index d04bd9486..fd657f652 100644 --- a/keyboards/s60_x/keymaps/spacefn/readme.md +++ b/keyboards/s60_x/keymaps/spacefn/readme.md | |||
@@ -1,5 +1,5 @@ | |||
1 | ### 6. SpaceFN | 1 | ### 6. SpaceFN |
2 | This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0). | 2 | This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [keymap.c](keymap.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0). |
3 | 3 | ||
4 | #### 6.0 Default layer | 4 | #### 6.0 Default layer |
5 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ | 5 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ |
diff --git a/keyboards/tada68/readme.md b/keyboards/tada68/readme.md index a18758ac9..d1c72cfa9 100755 --- a/keyboards/tada68/readme.md +++ b/keyboards/tada68/readme.md | |||
@@ -5,7 +5,7 @@ A compact 65% keyboard. | |||
5 | 5 | ||
6 | Keyboard Maintainer: QMK Community | 6 | Keyboard Maintainer: QMK Community |
7 | Hardware Supported: TADA68 PCB | 7 | Hardware Supported: TADA68 PCB |
8 | Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/products/tada68-mechanical-keyboard-gateron-swtich-65-layout-dye-sub-keycaps-cherry-profils?variant=34710238797) [kbdist](http://www.kbdist.com/shop/saber-68) | 8 | Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/products/tada68-mechanical-keyboard-gateron-swtich-65-layout-dye-sub-keycaps-cherry-profils?variant=34710238797) [kbdist](http://www.kbdist.com/) |
9 | 9 | ||
10 | Make example for this keyboard (after setting up your build environment): | 10 | Make example for this keyboard (after setting up your build environment): |
11 | 11 | ||
diff --git a/keyboards/tv44/readme.md b/keyboards/tv44/readme.md index c2394c031..f23ca0da5 100644 --- a/keyboards/tv44/readme.md +++ b/keyboards/tv44/readme.md | |||
@@ -5,7 +5,7 @@ A compact 44% keyboard. | |||
5 | 5 | ||
6 | Keyboard Maintainer: QMK Community | 6 | Keyboard Maintainer: QMK Community |
7 | Hardware Supported: The Van PCB | 7 | Hardware Supported: The Van PCB |
8 | Hardware Availability: https://thevankeyboards.com/products/minivan-r4-keyboard-kit?variant=37353952718 | 8 | Hardware Availability: https://thevankeyboards.com/collections/catalog/products/minivan-diy?variant=609138376718 |
9 | 9 | ||
10 | Make example for this keyboard (after setting up your build environment): | 10 | Make example for this keyboard (after setting up your build environment): |
11 | 11 | ||
diff --git a/layouts/community/ergodox/ab/readme.md b/layouts/community/ergodox/ab/readme.md index fde1c1726..22a7922d9 100644 --- a/layouts/community/ergodox/ab/readme.md +++ b/layouts/community/ergodox/ab/readme.md | |||
@@ -8,7 +8,7 @@ Beginner's keymap emulates standard QWERTY keyboard for beginners. Once you get | |||
8 | * Easy on beginners. It has everything you need for your day to day usage. | 8 | * Easy on beginners. It has everything you need for your day to day usage. |
9 | 9 | ||
10 | #### Cons | 10 | #### Cons |
11 | * Keys are not ergonomically placed to take full advantage of Ergodox-EZ. Take a look at this [Default Keymap](https://github.com/qmk/qmk_firmware/blob/master/keyboards/ergodox/keymaps/default/readme.md) | 11 | * Keys are not ergonomically placed to take full advantage of Ergodox-EZ. Take a look at this [Default Keymap](https://github.com/qmk/qmk_firmware/blob/master/layouts/default/ergodox/default_ergodox/keymap.c) |
12 | * While multiple layers are possible, beginner's keymap only uses one additional layer for mouse, function and volume keys. | 12 | * While multiple layers are possible, beginner's keymap only uses one additional layer for mouse, function and volume keys. |
13 | 13 | ||
14 | #### Notes | 14 | #### Notes |
diff --git a/layouts/community/ergodox/belak/README.md b/layouts/community/ergodox/belak/README.md index 30484e6e2..e251dc099 100644 --- a/layouts/community/ergodox/belak/README.md +++ b/layouts/community/ergodox/belak/README.md | |||
@@ -1,8 +1,8 @@ | |||
1 | # Belak's Ergodox Layout | 1 | # Belak's Ergodox Layout |
2 | 2 | ||
3 | This has been based off of [emacs\_osx\_dk](https://github.com/jackhumbert/qmk_firmware/tree/master/keyboards/ergodox/keymaps/emacs_osx_dk) | 3 | This has been based off of [emacs\_osx\_dk](https://github.com/qmk/qmk_firmware/tree/master/layouts/community/ergodox/emacs_osx_dk) |
4 | from the main qmk repo. However, I've taken some of the ideas for the thumbs | 4 | from the main qmk repo. However, I've taken some of the ideas for the thumbs |
5 | from [dvorak\_emacs](https://github.com/jackhumbert/qmk_firmware/tree/master/keyboards/ergodox/keymaps/dvorak_emacs) | 5 | from [dvorak\_emacs](https://github.com/qmk/qmk_firmware/tree/master/layouts/community/ergodox/dvorak_emacs) |
6 | and tweaked it a bit based on the keycaps I have. | 6 | and tweaked it a bit based on the keycaps I have. |
7 | 7 | ||
8 | This keyboard is intended for use in emacs (one of the main reasons for easy | 8 | This keyboard is intended for use in emacs (one of the main reasons for easy |
diff --git a/layouts/community/ergodox/familiar/README.md b/layouts/community/ergodox/familiar/README.md index 536179337..8d68af21a 100644 --- a/layouts/community/ergodox/familiar/README.md +++ b/layouts/community/ergodox/familiar/README.md | |||
@@ -1,7 +1,7 @@ | |||
1 | # ErgoDox Familiar Layout | 1 | # ErgoDox Familiar Layout |
2 | Familiar layout for those who regularly switch back and forth from ErgoDox to "normal" QWERTY. | 2 | Familiar layout for those who regularly switch back and forth from ErgoDox to "normal" QWERTY. |
3 | 3 | ||
4 | [](../../../../license_GPLv3.md../../../../license_GPLv3.md) [](https://github.com/RichardLitt/standard-readme) | 4 | [](../../../../license_GPLv3.md) [](https://github.com/RichardLitt/standard-readme) |
5 | 5 | ||
6 | ## Table of Contents | 6 | ## Table of Contents |
7 | 7 | ||
@@ -66,4 +66,4 @@ I'm terrible at this; I have no background in human-computer interaction, kinesi | |||
66 | 1. `MENU` and `LEAD` are useless, at the moment. | 66 | 1. `MENU` and `LEAD` are useless, at the moment. |
67 | 67 | ||
68 | ## License | 68 | ## License |
69 | QMK is licensed ([mostly](https://github.com/qmk/qmk_firmware/issues/1038)) under the [GPLv2](blob/master/license_GPLv2.md). Accordingly, to whatever extent applicable, this keymap is licensed under the [GPLv3](../../../../license_GPLv3.md). | 69 | QMK is licensed ([mostly](https://github.com/qmk/qmk_firmware/issues/1038)) under the [GPLv2](../../../../license_GPLv2.md). Accordingly, to whatever extent applicable, this keymap is licensed under the [GPLv3](../../../../license_GPLv3.md). |
diff --git a/layouts/community/ergodox/ordinary/readme.md b/layouts/community/ergodox/ordinary/readme.md index 2e8d86960..53cba0450 100644 --- a/layouts/community/ergodox/ordinary/readme.md +++ b/layouts/community/ergodox/ordinary/readme.md | |||
@@ -98,4 +98,4 @@ No rights reserved. This software is in the public domain. Credit me if you are | |||
98 | Keyboard layout images were created with http://www.keyboard-layout-editor.com/ by Ian Prest my thanks to that free service | 98 | Keyboard layout images were created with http://www.keyboard-layout-editor.com/ by Ian Prest my thanks to that free service |
99 | 99 | ||
100 | Details: readme.md | 100 | Details: readme.md |
101 | https://github.com/nrrkeene/qmk_firmware/tree/master/keyboards/ergodox/keymaps/ordinary | 101 | https://github.com/nrrkeene/qmk_firmware/tree/master/layouts/community/ergodox/ordinary |
diff --git a/layouts/community/ergodox/supercoder/readme.md b/layouts/community/ergodox/supercoder/readme.md index 7f2c9ef69..e82ec5970 100644 --- a/layouts/community/ergodox/supercoder/readme.md +++ b/layouts/community/ergodox/supercoder/readme.md | |||
@@ -15,8 +15,7 @@ Behold the Ultimate SuperCoder 2000 layout! | |||
15 | 15 | ||
16 | ### To use it... | 16 | ### To use it... |
17 | 17 | ||
18 | To use this piece of top quality engineering, you can either | 18 | To use this piece of top quality engineering, you must compile it on |
19 | [download the hex file][hex] we have prepared for you, or you can compile it on | ||
20 | your own: | 19 | your own: |
21 | 20 | ||
22 | [hex]: https://raw.githubusercontent.com/algernon/ergodox-supercoder/master/supercoder.hex | 21 | [hex]: https://raw.githubusercontent.com/algernon/ergodox-supercoder/master/supercoder.hex |
diff --git a/layouts/community/ergodox/tm2030/readme.md b/layouts/community/ergodox/tm2030/readme.md index 6cd794726..23746ddb7 100644 --- a/layouts/community/ergodox/tm2030/readme.md +++ b/layouts/community/ergodox/tm2030/readme.md | |||
@@ -9,7 +9,7 @@ Most of the TM2030 features are supported except | |||
9 | * show desktop key (at the right of the space key) | 9 | * show desktop key (at the right of the space key) |
10 | * 102/106 modes | 10 | * 102/106 modes |
11 | 11 | ||
12 | Dvorak mode is even supported by pressing [`Magic`](/TMK_readme.md#magic-commands)+`1` (`Magic` is by default `LShift`+`RShift`) | 12 | Dvorak mode is even supported by pressing [`Magic`](/docs/feature_bootmagic.md)+`1` (`Magic` is by default `LShift`+`RShift`) |
13 | 13 | ||
14 | Some keys had to be moved around to fit into the ErgoDox, especially the `F1`-`F12` keys and the arrow keys. | 14 | Some keys had to be moved around to fit into the ErgoDox, especially the `F1`-`F12` keys and the arrow keys. |
15 | 15 | ||
diff --git a/layouts/community/ergodox/townk_osx/readme.md b/layouts/community/ergodox/townk_osx/readme.md index a2dcd35fa..e10e44782 100644 --- a/layouts/community/ergodox/townk_osx/readme.md +++ b/layouts/community/ergodox/townk_osx/readme.md | |||
@@ -1,7 +1,7 @@ | |||
1 | # Townk's Keymap | 1 | # Townk's Keymap |
2 | 2 | ||
3 | Trying to take care of an enjury on my arm I borrow an ergonomic keyboard from | 3 | Trying to take care of an enjury on my arm I borrow an ergonomic keyboard from |
4 | a frient ([Kinesis Advantage](http://www.kinesis-ergo.com/shop/advantage-pro-for-pc-mac/)). | 4 | a frient ([Kinesis Advantage](https://www.kinesis-ergo.com/shop/advantage2/)). |
5 | 5 | ||
6 | I really enjoyed my time with it but there were some anoyancies: | 6 | I really enjoyed my time with it but there were some anoyancies: |
7 | 7 | ||
diff --git a/tmk_core/protocol/usb_hid/USB_Host_Shield_2.0/README.md b/tmk_core/protocol/usb_hid/USB_Host_Shield_2.0/README.md index 49cd83e0a..1eecb78ef 100644 --- a/tmk_core/protocol/usb_hid/USB_Host_Shield_2.0/README.md +++ b/tmk_core/protocol/usb_hid/USB_Host_Shield_2.0/README.md | |||
@@ -10,7 +10,7 @@ Project main web site is: <http://www.circuitsathome.com>. | |||
10 | 10 | ||
11 | Some information can also be found at: <http://blog.tkjelectronics.dk/>. | 11 | Some information can also be found at: <http://blog.tkjelectronics.dk/>. |
12 | 12 | ||
13 | The shield can be purchased at the main site: <http://www.circuitsathome.com/products-page/arduino-shields> or from [TKJ Electronics](http://tkjelectronics.com/): <http://shop.tkjelectronics.dk/product_info.php?products_id=43>. | 13 | The shield can be purchased at the main site: <https://www.circuitsathome.com/arduino_usb_host_shield_projects/> or from [TKJ Electronics](http://tkjelectronics.com/): <http://shop.tkjelectronics.dk/product_info.php?products_id=43>. |
14 | 14 | ||
15 |  | 15 |  |
16 | 16 | ||
@@ -196,7 +196,7 @@ Also take a look at the blog posts: | |||
196 | 196 | ||
197 | A special thanks go to the following people: | 197 | A special thanks go to the following people: |
198 | 198 | ||
199 | 1. _Richard Ibbotson_ who made this excellent guide: <http://www.circuitsathome.com/mcu/ps3-and-wiimote-game-controllers-on-the-arduino-host-shield-part> | 199 | 1. _Richard Ibbotson_ who made this excellent guide: <https://www.circuitsathome.com/mcu/ps3-and-wiimote-game-controllers-on-the-arduino-host-shield-part-1/> |
200 | 2. _Tomoyuki Tanaka_ for releasing his code for the Arduino USB Host shield connected to the wiimote: <http://www.circuitsathome.com/mcu/rc-car-controlled-by-wii-remote-on-arduino> | 200 | 2. _Tomoyuki Tanaka_ for releasing his code for the Arduino USB Host shield connected to the wiimote: <http://www.circuitsathome.com/mcu/rc-car-controlled-by-wii-remote-on-arduino> |
201 | 201 | ||
202 | Also a big thanks all the people behind these sites about the Motion controller: | 202 | Also a big thanks all the people behind these sites about the Motion controller: |
@@ -216,10 +216,10 @@ The [XBOXOLD](XBOXOLD.cpp) class implements support for the original Xbox contro | |||
216 | 216 | ||
217 | All the information are from the following sites: | 217 | All the information are from the following sites: |
218 | 218 | ||
219 | * <https://github.com/torvalds/linux/blob/master/Documentation/input/xpad.txt> | 219 | * <https://github.com/torvalds/linux/blob/master/Documentation/input/devices/xpad.rst> |
220 | * <https://github.com/torvalds/linux/blob/master/drivers/input/joystick/xpad.c> | 220 | * <https://github.com/torvalds/linux/blob/master/drivers/input/joystick/xpad.c> |
221 | * <http://euc.jp/periphs/xbox-controller.ja.html> | 221 | * <http://euc.jp/periphs/xbox-controller.ja.html> |
222 | * <https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL#L15> | 222 | * <https://github.com/Grumbel/xboxdrv/blob/stable/PROTOCOL#L15> |
223 | 223 | ||
224 | #### Xbox 360 Library | 224 | #### Xbox 360 Library |
225 | 225 | ||
@@ -241,7 +241,7 @@ All the information regarding the Xbox 360 controller protocol are form these si | |||
241 | 241 | ||
242 | * <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/UsbInfo> | 242 | * <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/UsbInfo> |
243 | * <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/WirelessUsbInfo> | 243 | * <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/WirelessUsbInfo> |
244 | * <https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL> | 244 | * <https://github.com/Grumbel/xboxdrv/blob/stable/PROTOCOL> |
245 | 245 | ||
246 | #### Xbox ONE Library | 246 | #### Xbox ONE Library |
247 | 247 | ||
diff --git a/tmk_core/protocol/usb_hid/USB_Host_Shield_2.0/examples/testusbhostFAT/README.md b/tmk_core/protocol/usb_hid/USB_Host_Shield_2.0/examples/testusbhostFAT/README.md index d8b4296b1..0f2a734a6 100644 --- a/tmk_core/protocol/usb_hid/USB_Host_Shield_2.0/examples/testusbhostFAT/README.md +++ b/tmk_core/protocol/usb_hid/USB_Host_Shield_2.0/examples/testusbhostFAT/README.md | |||
@@ -10,7 +10,7 @@ To compile this example you will need the following libraries as well: | |||
10 | * [generic_storage FATfs](https://github.com/xxxajk/generic_storage) | 10 | * [generic_storage FATfs](https://github.com/xxxajk/generic_storage) |
11 | * [RTClib](https://github.com/xxxajk/RTClib) | 11 | * [RTClib](https://github.com/xxxajk/RTClib) |
12 | 12 | ||
13 | The following shield is recommended for larger projects: <http://ruggedcircuits.com/html/quadram.html>. | 13 | The following shield is recommended for larger projects: <https://www.rugged-circuits.com/new-products/quadram>. |
14 | 14 | ||
15 | You may use the bundled [Makefile](Makefile) to compile the code instead of the Arduino IDE if you have problems or want a smaller binary. The master makefile is bundled as a submodule, but can also be downloaded manually at the following link: <https://github.com/xxxajk/Arduino_Makefile_master>. | 15 | You may use the bundled [Makefile](Makefile) to compile the code instead of the Arduino IDE if you have problems or want a smaller binary. The master makefile is bundled as a submodule, but can also be downloaded manually at the following link: <https://github.com/xxxajk/Arduino_Makefile_master>. |
16 | 16 | ||
diff --git a/tmk_core/readme.md b/tmk_core/readme.md index 5f135617c..a3783fe37 100644 --- a/tmk_core/readme.md +++ b/tmk_core/readme.md | |||
@@ -2,7 +2,7 @@ TMK Keyboard Firmware Core Library | |||
2 | ================================== | 2 | ================================== |
3 | This is a keyboard firmware library with some useful features for Atmel AVR and Cortex-M. | 3 | This is a keyboard firmware library with some useful features for Atmel AVR and Cortex-M. |
4 | 4 | ||
5 | Source code is available here: <https://github.com/tmk/tmk_keyboard/tree/core> | 5 | Source code is available here: <https://github.com/tmk/tmk_keyboard/tree/master/tmk_core> |
6 | 6 | ||
7 | 7 | ||
8 | Updates | 8 | Updates |
@@ -54,7 +54,7 @@ LUFA, PJRC and V-USB stack have their own license respectively. | |||
54 | 54 | ||
55 | Build Firmware and Program Controller | 55 | Build Firmware and Program Controller |
56 | ------------------------------------- | 56 | ------------------------------------- |
57 | See [doc/build.md](doc/build.md). | 57 | See [doc/build.md](https://github.com/tmk/tmk_keyboard/blob/master/tmk_core/doc/build.md). |
58 | 58 | ||
59 | 59 | ||
60 | 60 | ||