diff options
Diffstat (limited to 'keyboards')
30 files changed, 35 insertions, 39 deletions
diff --git a/keyboards/crawlpad/readme.md b/keyboards/crawlpad/readme.md index 98d04bfada..0bdc0f1722 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): 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. -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 +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 d24e66c864..5571f120cc 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 ## Debug See https://github.com/tmk/tmk_keyboard#magic-commands for command that can help -debug, together with the hid_listen tool (https://docs.qmk.fm/faq_debug.html).
\ No newline at end of file +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 10d84a0961..16ad9021cd 100644 --- a/keyboards/fc980c/README.md +++ b/keyboards/fc980c/README.md @@ -155,8 +155,8 @@ Datasheets - AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf - JST S5B-PH-SM4: http://www.jst-mfg.com/product/pdf/eng/ePH.pdf - Hirose UX60SC-MB-5S8: https://www.hirose.com/product/en/products/UX/UX60SC-MB-5S8%2880%29/ -- TYU TU1252WNR-05S: http://php2.twinner.com.tw/files/tyu/TU1252series.pdf - Tr(E42) for LED?: http://cj-elec.com/txUpfile/2013614923661845.pdf +- TYU TU1252WNR-05S: http://php2.twinner.com.tw/files/goodjob/TY1252series.pdf 3.3V power supply diff --git a/keyboards/handwired/CMD60/README.md b/keyboards/handwired/CMD60/README.md index 83e371543e..8b0dd109f6 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 ## Quantum MK Firmware -For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). +For the full Quantum feature list, see [the parent readme.md](/docs/README.md). ## Building diff --git a/keyboards/handwired/fivethirteen/README.md b/keyboards/handwired/fivethirteen/README.md index b2e13cd6dc..a965650fc6 100644 --- a/keyboards/handwired/fivethirteen/README.md +++ b/keyboards/handwired/fivethirteen/README.md @@ -3,7 +3,7 @@ fivethirteen keyboard firmware ## Quantum MK Firmware -For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). +For the full Quantum feature list, see [the parent readme.md](/doc/README.md). ## Building diff --git a/keyboards/handwired/gamenum/README.md b/keyboards/handwired/gamenum/README.md index 5b53004efd..bf8045be19 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 ## Quantum MK Firmware -For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). +For the full Quantum feature list, see [the parent readme.md](/docs/README.md). ## Building diff --git a/keyboards/handwired/minorca/readme.md b/keyboards/handwired/minorca/readme.md index 93c767954d..0253506e09 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 - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck) - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c) - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck) -- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid) +- [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 11bcba54ad..8cdbb47d66 100755 --- a/keyboards/handwired/reddot/readme.md +++ b/keyboards/handwired/reddot/readme.md @@ -3,7 +3,7 @@ ## Quantum MK Firmware -For the full Quantum feature list, see [the parent README.md](/README.md). +For the full Quantum feature list, see [the parent README.md](/readme.md). ## Building diff --git a/keyboards/handwired/traveller/readme.md b/keyboards/handwired/traveller/readme.md index 646844b1d7..0be53a9628 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 ## Quantum MK Firmware -For the full Quantum feature list, see [the parent README.md](/README.md). +For the full Quantum feature list, see [the parent README.md](/readme.md). ## Building diff --git a/keyboards/jd40/readme.md b/keyboards/jd40/readme.md index 6934e54d41..c5ab42ed05 100644 --- a/keyboards/jd40/readme.md +++ b/keyboards/jd40/readme.md @@ -5,7 +5,7 @@ A compact 40% keyboard. Keyboard Maintainer: QMK Community Hardware Supported: JD40 PCB -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) +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) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/kinesis/alvicstep/readme.md b/keyboards/kinesis/alvicstep/readme.md index 974e42e506..810a7aba16 100644 --- a/keyboards/kinesis/alvicstep/readme.md +++ b/keyboards/kinesis/alvicstep/readme.md @@ -23,7 +23,7 @@ Not yet implemented: ## Quantum MK Firmware -For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). +For the full Quantum feature list, see [the parent readme.md](/docs/README.md). ## Building diff --git a/keyboards/kinesis/stapelberg/readme.md b/keyboards/kinesis/stapelberg/readme.md index 1a408a15f8..0dcb7c283f 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. | Reset cables | 2 | Sparkfun | PRT-09140 | The board and connections are shown here - + The Teensy mounting detail can be seen here. I used a socket for prototyping. - + 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. Shorting these two pins together will reset the board. I also put female to male header jumper cables on these so they could be accessed outside the enclosure. The exterior cables can be seen here. - + ## Keymaps @@ -52,7 +52,3 @@ To build with the default keymap, run `make default` while in the This keymap contains a dvorak implementation as well as media and symbol layers. Run `make dvorak` while in the `kinesis_stapelberg` working directory. - - - -
\ No newline at end of file diff --git a/keyboards/kmac/readme.md b/keyboards/kmac/readme.md index e7d97778f6..fccf902cab 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 ### Custom keymaps -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. +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. To make it easy to define keymaps for the different versions of the PCB two macros are provided. diff --git a/keyboards/lets_split/readme.md b/keyboards/lets_split/readme.md index 155f69f156..80fe08b93c 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: lets_split_rev2_YOUR_KEYMAP_NAME.hex ``` -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. +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. ### Let's split 1.0 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 5f23d988a0..7dd8337e8a 100644 --- a/keyboards/lfkeyboards/lfkpad/readme.md +++ b/keyboards/lfkeyboards/lfkpad/readme.md @@ -3,7 +3,7 @@ bluepad keyboard firmware ## Quantum MK Firmware -For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). +For the full Quantum feature list, see [the parent readme.md](/docs/README.md). ## Building diff --git a/keyboards/mitosis/readme.md b/keyboards/mitosis/readme.md index 3cbdbae61a..0d5a74a1dc 100644 --- a/keyboards/mitosis/readme.md +++ b/keyboards/mitosis/readme.md @@ -3,7 +3,7 @@ Mitosis A wireless split compact keyboard. -Keyboard Maintainer: [@reversebias](https://github.com/reversebias] +Keyboard Maintainer: [@reversebias](https://github.com/reversebias) Hardware Supported: Mitosis PCB Hardware Availability: https://www.reddit.com/r/MechanicalKeyboards/comments/66588f/wireless_split_qmk_mitosis/ diff --git a/keyboards/nyquist/keymaps/333fred/README.md b/keyboards/nyquist/keymaps/333fred/README.md index aa783af07f..fa354bb4d3 100644 --- a/keyboards/nyquist/keymaps/333fred/README.md +++ b/keyboards/nyquist/keymaps/333fred/README.md @@ -1,6 +1,6 @@ # 333fred's Nyquist Layout -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. +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. ## Layers diff --git a/keyboards/planck/keymaps/grahampheath/readme.md b/keyboards/planck/keymaps/grahampheath/readme.md index ec8020f18c..507120c6f1 100644 --- a/keyboards/planck/keymaps/grahampheath/readme.md +++ b/keyboards/planck/keymaps/grahampheath/readme.md @@ -1,4 +1,4 @@ # Graham's Planck ## Sounds -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). +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 35900f611f..5ba98c6c45 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 * [Lets Split](/keyboards/lets_split) - Split ortholinear 40% keyboard. * [Phantom](/keyboards/phantom) — A tenkeyless kit by Teel, also from Geekhack. * [Retro Refit](/keyboards/retro_refit) — Another creation by IBNobody. -* [S60-x](/keyboards/s60-x) — DIY compact keyboard designed by VinnyCordeiro for Sentraq. +* [S60-x](/keyboards/s60_x) — DIY compact keyboard designed by VinnyCordeiro for Sentraq. * [Satan](/keyboards/satan) — A GH60 variant. * [SixKeyBoard](/keyboards/sixkeyboard) — A 6-key keyboard made by TechKeys. * [TheVan 44](/keyboards/tv44) — A 44-key staggered keybard by Evangs. diff --git a/keyboards/roadkit/readme.md b/keyboards/roadkit/readme.md index fbc40a50fd..245d5242ae 100644 --- a/keyboards/roadkit/readme.md +++ b/keyboards/roadkit/readme.md @@ -5,7 +5,7 @@ A programmable macro pad. Keyboard Maintainer: QMK Community Hardware Supported: Roadkit PCB -Hardware Availability: https://thevankeyboards.com/products/roadkit-r2?variant=37353813966 +Hardware Availability: https://thevankeyboards.com/collections/catalog/products/road-kit-diy?variant=603645345806 Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/s60_x/keymaps/custom/readme.md b/keyboards/s60_x/keymaps/custom/readme.md index cf87bd915f..fd79d53607 100644 --- a/keyboards/s60_x/keymaps/custom/readme.md +++ b/keyboards/s60_x/keymaps/custom/readme.md @@ -1,5 +1,5 @@ ### 8 Custom -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. +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. #### 8.0 Default layer ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ diff --git a/keyboards/s60_x/keymaps/hasu/readme.md b/keyboards/s60_x/keymaps/hasu/readme.md index 64969b616d..b79d0e97a5 100644 --- a/keyboards/s60_x/keymaps/hasu/readme.md +++ b/keyboards/s60_x/keymaps/hasu/readme.md @@ -1,4 +1,4 @@ ### 5. Hasu -This is Hasu's favorite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail. +This is Hasu's favorite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [keymap.c](keymap.c) for detail. (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 2bceb26dd5..c7dcec899f 100644 --- a/keyboards/s60_x/keymaps/hhkb/readme.md +++ b/keyboards/s60_x/keymaps/hhkb/readme.md @@ -1,5 +1,5 @@ ### 7. HHKB -[keymap_hhkb.c](keymap_hhkb.c) emulates original HHKB layers. +[keymap.c](keymap.c) emulates original HHKB layers. #### 7.0: Default layer ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ │ 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 ab13323e3b..02f524495e 100644 --- a/keyboards/s60_x/keymaps/plain/readme.md +++ b/keyboards/s60_x/keymaps/plain/readme.md @@ -1,6 +1,6 @@ ### 4. Plain Without any Fn layer this will be useful if you want to use key remapping tool like AHK on host. -See [keymap_plain.c](keymap_plain.c) for detail. +See [keymap.c](keymap.c) for detail. #### 4.0 Plain Default layer ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ diff --git a/keyboards/s60_x/keymaps/poker/readme.md b/keyboards/s60_x/keymaps/poker/readme.md index 0d8be9d0f8..04d2b78bef 100644 --- a/keyboards/s60_x/keymaps/poker/readme.md +++ b/keyboards/s60_x/keymaps/poker/readme.md @@ -1,6 +1,6 @@ ### 3 Poker -[keymap_poker.c](keymap_poker.c) emulates original Poker layers -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. +[keymap_poker](../poker/readme.md) emulates original Poker layers +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. Fn + Esc = ` 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 0d8be9d0f8..04d2b78bef 100644 --- a/keyboards/s60_x/keymaps/poker_bit/readme.md +++ b/keyboards/s60_x/keymaps/poker_bit/readme.md @@ -1,6 +1,6 @@ ### 3 Poker -[keymap_poker.c](keymap_poker.c) emulates original Poker layers -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. +[keymap_poker](../poker/readme.md) emulates original Poker layers +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. Fn + Esc = ` 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 0d8be9d0f8..04d2b78bef 100644 --- a/keyboards/s60_x/keymaps/poker_set/readme.md +++ b/keyboards/s60_x/keymaps/poker_set/readme.md @@ -1,6 +1,6 @@ ### 3 Poker -[keymap_poker.c](keymap_poker.c) emulates original Poker layers -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. +[keymap_poker](../poker/readme.md) emulates original Poker layers +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. Fn + Esc = ` 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 d04bd94865..fd657f6526 100644 --- a/keyboards/s60_x/keymaps/spacefn/readme.md +++ b/keyboards/s60_x/keymaps/spacefn/readme.md @@ -1,5 +1,5 @@ ### 6. SpaceFN -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). +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). #### 6.0 Default layer ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ diff --git a/keyboards/tada68/readme.md b/keyboards/tada68/readme.md index a18758ac94..d1c72cfa95 100755 --- a/keyboards/tada68/readme.md +++ b/keyboards/tada68/readme.md @@ -5,7 +5,7 @@ A compact 65% keyboard. Keyboard Maintainer: QMK Community Hardware Supported: TADA68 PCB -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) +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/) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/tv44/readme.md b/keyboards/tv44/readme.md index c2394c0313..f23ca0da52 100644 --- a/keyboards/tv44/readme.md +++ b/keyboards/tv44/readme.md @@ -5,7 +5,7 @@ A compact 44% keyboard. Keyboard Maintainer: QMK Community Hardware Supported: The Van PCB -Hardware Availability: https://thevankeyboards.com/products/minivan-r4-keyboard-kit?variant=37353952718 +Hardware Availability: https://thevankeyboards.com/collections/catalog/products/minivan-diy?variant=609138376718 Make example for this keyboard (after setting up your build environment): |