mirror of
https://github.com/Keychron/qmk_firmware.git
synced 2024-12-24 18:25:01 +06:00
Fixed dead links (#2451)
* Fixed typo of 'confid.h' to 'config.h' * Fixed broken links in docs * Fixed a lot of dead links
This commit is contained in:
Brian Choromanski
skullydazed
parent
2b8a82fb9d
commit
7f7f763598
@ -40,7 +40,7 @@ You can use these keycodes within your keymap to map button presses to mouse act
|
||||
|`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1|
|
||||
|`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2|
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
## Configuring the Behavior of Mousekeys
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
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.
|
||||
A line of 8-bit MCU's produced by [Atmel](http://www.microchip.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.
|
||||
|
||||
@ -77,7 +77,7 @@ At the keyboard level we define a C macro (typically named `KEYMAP()`) which map
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
##### Keycode Assignment
|
||||
|
||||
@ -135,8 +135,8 @@ The `process_record()` function itself is deceptively simple, but hidden within
|
||||
* [`void process_record(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/action.c#L128)
|
||||
* [`bool process_record_quantum(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L140)
|
||||
* [Map this record to a keycode](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L143)
|
||||
* [`bool process_record_kb(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/cluecard/cluecard.c#L20)
|
||||
* [`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)
|
||||
* [`bool process_record_kb(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/card/card.c#L20)
|
||||
* [`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)
|
||||
* [`bool process_midi(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_midi.c#L102)
|
||||
* [`bool process_audio(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_audio.c#L10)
|
||||
* [`bool process_music(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_music.c#L69)
|
||||
|
||||
@ -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].
|
||||
For those that prefer a GUI tool, the crawlpad.json file in this repo can be used on [kbfirmware.com](http://kbfirmware.com).
|
||||
@ -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).
|
||||
debug, together with the [hid_listen tool](https://docs.qmk.fm/faq_debug.html).
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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)
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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):
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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/
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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).
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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):
|
||||
|
||||
|
||||
@ -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
|
||||
┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
|
||||
|
||||
@ -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.)
|
||||
@ -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 │ - │ = │ \ │ ` │
|
||||
|
||||
@ -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
|
||||
┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
|
||||
|
||||
@ -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}
|
||||
|
||||
@ -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}
|
||||
|
||||
@ -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}
|
||||
|
||||
@ -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
|
||||
┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
|
||||
|
||||
@ -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):
|
||||
|
||||
|
||||
@ -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):
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ Beginner's keymap emulates standard QWERTY keyboard for beginners. Once you get
|
||||
* Easy on beginners. It has everything you need for your day to day usage.
|
||||
|
||||
#### Cons
|
||||
* 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)
|
||||
* 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)
|
||||
* While multiple layers are possible, beginner's keymap only uses one additional layer for mouse, function and volume keys.
|
||||
|
||||
#### Notes
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
# Belak's Ergodox Layout
|
||||
|
||||
This has been based off of [emacs\_osx\_dk](https://github.com/jackhumbert/qmk_firmware/tree/master/keyboards/ergodox/keymaps/emacs_osx_dk)
|
||||
This has been based off of [emacs\_osx\_dk](https://github.com/qmk/qmk_firmware/tree/master/layouts/community/ergodox/emacs_osx_dk)
|
||||
from the main qmk repo. However, I've taken some of the ideas for the thumbs
|
||||
from [dvorak\_emacs](https://github.com/jackhumbert/qmk_firmware/tree/master/keyboards/ergodox/keymaps/dvorak_emacs)
|
||||
from [dvorak\_emacs](https://github.com/qmk/qmk_firmware/tree/master/layouts/community/ergodox/dvorak_emacs)
|
||||
and tweaked it a bit based on the keycaps I have.
|
||||
|
||||
This keyboard is intended for use in emacs (one of the main reasons for easy
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# ErgoDox Familiar Layout
|
||||
Familiar layout for those who regularly switch back and forth from ErgoDox to "normal" QWERTY.
|
||||
|
||||
[](../../../../license_GPLv3.md../../../../license_GPLv3.md) [](https://github.com/RichardLitt/standard-readme)
|
||||
[](../../../../license_GPLv3.md) [](https://github.com/RichardLitt/standard-readme)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@ -66,4 +66,4 @@ I'm terrible at this; I have no background in human-computer interaction, kinesi
|
||||
1. `MENU` and `LEAD` are useless, at the moment.
|
||||
|
||||
## License
|
||||
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).
|
||||
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).
|
||||
|
||||
@ -98,4 +98,4 @@ No rights reserved. This software is in the public domain. Credit me if you are
|
||||
Keyboard layout images were created with http://www.keyboard-layout-editor.com/ by Ian Prest my thanks to that free service
|
||||
|
||||
Details: readme.md
|
||||
https://github.com/nrrkeene/qmk_firmware/tree/master/keyboards/ergodox/keymaps/ordinary
|
||||
https://github.com/nrrkeene/qmk_firmware/tree/master/layouts/community/ergodox/ordinary
|
||||
|
||||
@ -15,8 +15,7 @@ Behold the Ultimate SuperCoder 2000 layout!
|
||||
|
||||
### To use it...
|
||||
|
||||
To use this piece of top quality engineering, you can either
|
||||
[download the hex file][hex] we have prepared for you, or you can compile it on
|
||||
To use this piece of top quality engineering, you must compile it on
|
||||
your own:
|
||||
|
||||
[hex]: https://raw.githubusercontent.com/algernon/ergodox-supercoder/master/supercoder.hex
|
||||
|
||||
@ -9,7 +9,7 @@ Most of the TM2030 features are supported except
|
||||
* show desktop key (at the right of the space key)
|
||||
* 102/106 modes
|
||||
|
||||
Dvorak mode is even supported by pressing [`Magic`](/TMK_readme.md#magic-commands)+`1` (`Magic` is by default `LShift`+`RShift`)
|
||||
Dvorak mode is even supported by pressing [`Magic`](/docs/feature_bootmagic.md)+`1` (`Magic` is by default `LShift`+`RShift`)
|
||||
|
||||
Some keys had to be moved around to fit into the ErgoDox, especially the `F1`-`F12` keys and the arrow keys.
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# Townk's Keymap
|
||||
|
||||
Trying to take care of an enjury on my arm I borrow an ergonomic keyboard from
|
||||
a frient ([Kinesis Advantage](http://www.kinesis-ergo.com/shop/advantage-pro-for-pc-mac/)).
|
||||
a frient ([Kinesis Advantage](https://www.kinesis-ergo.com/shop/advantage2/)).
|
||||
|
||||
I really enjoyed my time with it but there were some anoyancies:
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ Project main web site is: <http://www.circuitsathome.com>.
|
||||
|
||||
Some information can also be found at: <http://blog.tkjelectronics.dk/>.
|
||||
|
||||
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>.
|
||||
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>.
|
||||
|
||||
|
||||
|
||||
@ -196,7 +196,7 @@ Also take a look at the blog posts:
|
||||
|
||||
A special thanks go to the following people:
|
||||
|
||||
1. _Richard Ibbotson_ who made this excellent guide: <http://www.circuitsathome.com/mcu/ps3-and-wiimote-game-controllers-on-the-arduino-host-shield-part>
|
||||
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/>
|
||||
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>
|
||||
|
||||
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
|
||||
|
||||
All the information are from the following sites:
|
||||
|
||||
* <https://github.com/torvalds/linux/blob/master/Documentation/input/xpad.txt>
|
||||
* <https://github.com/torvalds/linux/blob/master/Documentation/input/devices/xpad.rst>
|
||||
* <https://github.com/torvalds/linux/blob/master/drivers/input/joystick/xpad.c>
|
||||
* <http://euc.jp/periphs/xbox-controller.ja.html>
|
||||
* <https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL#L15>
|
||||
* <https://github.com/Grumbel/xboxdrv/blob/stable/PROTOCOL#L15>
|
||||
|
||||
#### Xbox 360 Library
|
||||
|
||||
@ -241,7 +241,7 @@ All the information regarding the Xbox 360 controller protocol are form these si
|
||||
|
||||
* <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/UsbInfo>
|
||||
* <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/WirelessUsbInfo>
|
||||
* <https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL>
|
||||
* <https://github.com/Grumbel/xboxdrv/blob/stable/PROTOCOL>
|
||||
|
||||
#### Xbox ONE Library
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ To compile this example you will need the following libraries as well:
|
||||
* [generic_storage FATfs](https://github.com/xxxajk/generic_storage)
|
||||
* [RTClib](https://github.com/xxxajk/RTClib)
|
||||
|
||||
The following shield is recommended for larger projects: <http://ruggedcircuits.com/html/quadram.html>.
|
||||
The following shield is recommended for larger projects: <https://www.rugged-circuits.com/new-products/quadram>.
|
||||
|
||||
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>.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@ TMK Keyboard Firmware Core Library
|
||||
==================================
|
||||
This is a keyboard firmware library with some useful features for Atmel AVR and Cortex-M.
|
||||
|
||||
Source code is available here: <https://github.com/tmk/tmk_keyboard/tree/core>
|
||||
Source code is available here: <https://github.com/tmk/tmk_keyboard/tree/master/tmk_core>
|
||||
|
||||
|
||||
Updates
|
||||
@ -54,7 +54,7 @@ LUFA, PJRC and V-USB stack have their own license respectively.
|
||||
|
||||
Build Firmware and Program Controller
|
||||
-------------------------------------
|
||||
See [doc/build.md](doc/build.md).
|
||||
See [doc/build.md](https://github.com/tmk/tmk_keyboard/blob/master/tmk_core/doc/build.md).
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user