sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Quick fixup links on English documentation

Browse Source 
Because of the previous moving commit, some links need to be fixed too.
This commit is contained in:
AndersonTorres 2022-09-11 16:32:11 -03:00 committed by Kyle Brown
parent 0ab6887fbe
commit afd184f019
5 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/README.md
View File

@ -1,6 +1,6 @@
# Documentation index # Documentation index
> Before you look further, you probably want to start with our [getting started guide](https://github.com/KMKfw/kmk_firmware/blob/master/docs/Getting_Started.md) > Before you look further, you probably want to start with our [getting started guide](https://github.com/KMKfw/kmk_firmware/blob/master/docs/en/Getting_Started.md)
## Basics ## Basics
@ -50,5 +50,5 @@
## Language versions ## Language versions
- [Japanese getting started](ja/Getting_Started.md) - [Japanese getting started](https://github.com/KMKfw/kmk_firmware/tree/master/docs/ja/Getting_Started.md)
- [Brazilian Portuguese](https://github.com/KMKfw/kmk_firmware/tree/master/docs/ptBR) - [Brazilian Portuguese](https://github.com/KMKfw/kmk_firmware/tree/master/docs/ptBR)

4
docs/en/config_and_keymap.md
View File

@ -12,7 +12,7 @@ Let's dive in!
free to submit a pull request with your layout definitions!) and copy it over free to submit a pull request with your layout definitions!) and copy it over
(either manually or, if you're adept with developer tooling and/or a command (either manually or, if you're adept with developer tooling and/or a command
line, [our line, [our
Makefile](https://github.com/KMKfw/kmk_firmware/blob/master/docs/flashing.md)). Makefile](https://github.com/KMKfw/kmk_firmware/blob/master/docs/en/flashing.md)).
It's definitely recommended to keep a backup of your configuration somewhere It's definitely recommended to keep a backup of your configuration somewhere
that isn't the microcontroller itself - MCUs die, CircuitPython may run into that isn't the microcontroller itself - MCUs die, CircuitPython may run into
corruption bugs, or you might just have bad luck and delete the wrong file corruption bugs, or you might just have bad luck and delete the wrong file
@ -59,7 +59,7 @@ print(dir(board))
- Import the global list of key definitions with `from kmk.keys import KC`. You - Import the global list of key definitions with `from kmk.keys import KC`. You
can either print this out in the REPL as we did with `board` above, or simply can either print this out in the REPL as we did with `board` above, or simply
look at [our Key look at [our Key
documentation](https://github.com/KMKfw/kmk_firmware/blob/master/docs/keycodes.md). documentation](https://github.com/KMKfw/kmk_firmware/blob/master/docs/en/keycodes.md).
We've tried to keep that listing reasonably up to date, but if it feels like We've tried to keep that listing reasonably up to date, but if it feels like
something is missing, you may need to read through `kmk/keys.py` (and then something is missing, you may need to read through `kmk/keys.py` (and then
open a ticket to tell us our docs are out of date, or open a PR and fix the open a ticket to tell us our docs are out of date, or open a PR and fix the

24
docs/en/keycodes.md
View File

@ -183,18 +183,18 @@
## [Internal Keys] ## [Internal Keys]
|Key |Description | | Key | Description |
|-----------------------|---------------------------------------------------------------------| |-------------------------|---------------------------------------------------------------------------------|
|`KC.RESET` |Restarts the keyboard | | `KC.RESET` | Restarts the keyboard |
|`KC.RELOAD`, `KC.RLD` |Reloads the keyboard software, preserving any serial connections | | `KC.RELOAD`, `KC.RLD` | Reloads the keyboard software, preserving any serial connections |
|`KC.DEBUG` |Toggle `debug_enabled`, which enables log spew to serial console | | `KC.DEBUG` | Toggle `debug_enabled`, which enables log spew to serial console |
|`KC.GESC` |Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI| | `KC.GESC` | Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI |
|`KC.BKDL` |Backspace when tapped, Delete when pressed with GUI | | `KC.BKDL` | Backspace when tapped, Delete when pressed with GUI |
|`KC.UC_MODE_NOOP` |Sets UnicodeMode to NOOP | | `KC.UC_MODE_NOOP` | Sets UnicodeMode to NOOP |
|`KC.UC_MODE_LINUX` |Sets UnicodeMode to Linux | | `KC.UC_MODE_LINUX` | Sets UnicodeMode to Linux |
|`KC.UC_MODE_MACOS` |Sets UnicodeMode to macOS | | `KC.UC_MODE_MACOS` | Sets UnicodeMode to macOS |
|`KC.UC_MODE_WINC` |Sets UnicodeMode to WinCompose | | `KC.UC_MODE_WINC` | Sets UnicodeMode to WinCompose |
|`KC.MACRO_SLEEP_MS(ms)`|Sleeps in a macro. See [SEQUENCES](/docs/sequences.md) for more information. | | `KC.MACRO_SLEEP_MS(ms)` | Sleeps in a macro. See [SEQUENCES](/docs/en/sequences.md) for more information. |
## [Modifiers] ## [Modifiers]

6
docs/en/keys.md
View File

@ -1,7 +1,7 @@
# Keys # Keys
> NOTE: This is not a lookup table of key objects provided by KMK. That listing > NOTE: This is not a lookup table of key objects provided by KMK. That listing
> can be found in [`keycodes.md`](/docs/keycodes.md). It's probably worth a look at the raw source if > can be found in [`keycodes.md`](/docs/en/keycodes.md). It's probably worth a look at the raw source if
> you're stumped: [`kmk/keys.py`](/kmk/keys.py). > you're stumped: [`kmk/keys.py`](/kmk/keys.py).
This is a bunch of documentation about how a physical keypress translates to This is a bunch of documentation about how a physical keypress translates to
@ -31,7 +31,7 @@ objects have a few core pieces of information:
- Their attached modifiers (to implement things like shifted keys or `KC.HYPR`, - Their attached modifiers (to implement things like shifted keys or `KC.HYPR`,
which are single key presses sending along more than one key in a single HID which are single key presses sending along more than one key in a single HID
report. This is a distinct concept from Sequences, which are a KMK feature report. This is a distinct concept from Sequences, which are a KMK feature
documented in [`sequences.md`](/docs/sequences.md)). For almost all purposes outside of KMK core, documented in [`sequences.md`](/docs/en/sequences.md)). For almost all purposes outside of KMK core,
this field should be ignored - it can be safely populated through far more this field should be ignored - it can be safely populated through far more
sane means than futzing with it by hand. sane means than futzing with it by hand.
@ -48,7 +48,7 @@ objects have a few core pieces of information:
functions and some special override keys (like `KC.GESC`, which is an enhanced functions and some special override keys (like `KC.GESC`, which is an enhanced
form of existing ANSI keys) in [`kmk/handlers/stock.py`](/kmk/handlers/stock.py), for layer switching in form of existing ANSI keys) in [`kmk/handlers/stock.py`](/kmk/handlers/stock.py), for layer switching in
[`kmk/modules/layers.py`](/kmk/modules/layers.py), and for everything related to Sequences (see [`kmk/modules/layers.py`](/kmk/modules/layers.py), and for everything related to Sequences (see
[`sequences.md`](/docs/sequences.md) again) in [`kmk/handlers/sequences.py`](/kmk/handlers/sequences.py). We'll discuss these more [`sequences.md`](/docs/en/sequences.md) again) in [`kmk/handlers/sequences.py`](/kmk/handlers/sequences.py). We'll discuss these more
shortly. shortly.
- Optional callbacks to be run before and/or after the above handlers. More on - Optional callbacks to be run before and/or after the above handlers. More on

2
docs/en/rapidfire.md
View File

@ -7,7 +7,7 @@ Some instances where this may be useful are:
- MMOs and other games where you are encouraged to repeatedly spam a key - MMOs and other games where you are encouraged to repeatedly spam a key
- More responsive volume up and volume down - More responsive volume up and volume down
- Faster cursor key navigation - Faster cursor key navigation
- Combine with the [Mouse Keys](https://github.com/KMKfw/kmk_firmware/blob/master/docs/mouse_keys.md) module to create rapid-fire mouse clicks - Combine with the [Mouse Keys](https://github.com/KMKfw/kmk_firmware/blob/master/docs/en/mouse_keys.md) module to create rapid-fire mouse clicks
- Anywhere else you may need an ergonomic alternative to repetitive key tapping - Anywhere else you may need an ergonomic alternative to repetitive key tapping
## Keycodes ## Keycodes