Get rid of hard reference to https://github.com/KMKfw/kmk_firmware/blob/master/
This commit is contained in:
parent
b9c6e5bfea
commit
296e4a31b8
14
README.md
14
README.md
@ -30,24 +30,24 @@ channel below.
|
||||
on a "flash-drive"-esque space on your microcontroller - edit on the go
|
||||
without DFU or other devtooling available!
|
||||
- Single-piece or [two-piece split
|
||||
keyboards](https://github.com/KMKfw/kmk_firmware/blob/master/docs/split_keyboards.md)
|
||||
keyboards](/docs/split_keyboards.md)
|
||||
are supported
|
||||
- [Chainable
|
||||
keys](https://github.com/KMKfw/kmk_firmware/blob/master/docs/keys.md) such as
|
||||
keys](/docs/keys.md) such as
|
||||
`KC.LWIN(KC.L)` to lock the screen on a Windows PC
|
||||
- [Built-in Unicode macros, including
|
||||
emojis](https://github.com/KMKfw/kmk_firmware/blob/master/docs/sequences.md)
|
||||
- [RGB underglow](https://github.com/KMKfw/kmk_firmware/blob/master/docs/rgb.md)
|
||||
emojis](/docs/sequences.md)
|
||||
- [RGB underglow](/docs/rgb.md)
|
||||
and [LED
|
||||
backlights](https://github.com/KMKfw/kmk_firmware/blob/master/docs/led.md)
|
||||
backlights](/docs/led.md)
|
||||
- One key can turn into many more based on [how many times you tap
|
||||
it](https://github.com/KMKfw/kmk_firmware/blob/master/docs/tapdance.md)
|
||||
it](/docs/tapdance.md)
|
||||
- Bluetooth HID and split keyboards. No more wires.
|
||||
|
||||
## Getting Started
|
||||
KMK requires [CircuitPython](https://circuitpython.org/) version 7.0 or higher.
|
||||
Our getting started guide can be found
|
||||
[here](https://github.com/KMKfw/kmk_firmware/blob/master/docs/Getting_Started.md).
|
||||
[here](/docs/Getting_Started.md).
|
||||
|
||||
## The KMK Team
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# 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/en/Getting_Started.md)
|
||||
> Before you look further, you probably want to start with our [getting started guide](/docs/en/Getting_Started.md)
|
||||
|
||||
## Basics
|
||||
|
||||
|
@ -12,7 +12,7 @@ Let's dive in!
|
||||
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
|
||||
line, [our
|
||||
Makefile](https://github.com/KMKfw/kmk_firmware/blob/master/docs/en/flashing.md)).
|
||||
Makefile](/docs/en/flashing.md)).
|
||||
It's definitely recommended to keep a backup of your configuration somewhere
|
||||
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
|
||||
@ -59,7 +59,7 @@ print(dir(board))
|
||||
- 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
|
||||
look at [our Key
|
||||
documentation](https://github.com/KMKfw/kmk_firmware/blob/master/docs/en/keycodes.md).
|
||||
documentation](/docs/en/keycodes.md).
|
||||
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
|
||||
open a ticket to tell us our docs are out of date, or open a PR and fix the
|
||||
|
@ -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
|
||||
- More responsive volume up and volume down
|
||||
- Faster cursor key navigation
|
||||
- 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
|
||||
- Combine with the [Mouse Keys](/docs/en/mouse_keys.md) module to create rapid-fire mouse clicks
|
||||
- Anywhere else you may need an ergonomic alternative to repetitive key tapping
|
||||
|
||||
## Keycodes
|
||||
|
@ -65,7 +65,7 @@ if __name__ == '__main__':
|
||||
### フルサポートされているキーボードを持っている場合
|
||||
あなたのキーボードとマイコンが正式にサポートされている場合、[こちらのページ](https://github.com/KMKfw/boards)から`kb.py` と `main.py`を"flash drive"のルートに落とす必要があります。より高度な手順は[こちら](config_and_keymap.md)から確認できます。
|
||||
|
||||
Circuitpython を使用する場合、 [boot.py](https://github.com/KMKfw/kmk_firmware/blob/master/boot.py)も必要になります。
|
||||
Circuitpython を使用する場合、 [boot.py](/boot.py)も必要になります。
|
||||
|
||||
### ほかに自作ボードなどを持っていて、カスタマイズされた KMK を導入したい場合
|
||||
|
||||
|
@ -13,7 +13,7 @@ mergulhar!
|
||||
`user_keymaps` - sinta-se livre para submeter um PR com suas definições de
|
||||
layout!) e copie-o (seja manualmente, ou se você é adepto de ferramentas de
|
||||
desenvolvimento e linha de comando, usando nosso
|
||||
[Makefile](https://github.com/KMKfw/kmk_firmware/blob/master/docs/ptBR/flashing.md)).
|
||||
[Makefile](/docs/ptBR/flashing.md)).
|
||||
Definitivamente é recomendado que você mantenha uma cópia extra de segurança
|
||||
em algum lugar que não o micro-controlador - chips pifam, Circuitpython pode
|
||||
ter problemas de corrupção. ou você pode estar em um dia ruim e apagar o
|
||||
@ -61,7 +61,7 @@ print(dir(board))
|
||||
- Importe a lista global de definições com `from kmk.keys import KC`. Você pode
|
||||
ou exibi-la no REPL como fizemos acima com `board`, ou simplesmente olhar na
|
||||
nossa
|
||||
[documentação](https://github.com/KMKfw/kmk_firmware/blob/master/docs/ptBR/keycodes.md).
|
||||
[documentação](/docs/ptBR/keycodes.md).
|
||||
Tentamos manter a lista razoavelmente atualizada, mas se tiver algo faltando,
|
||||
você pode ter que ler o arquivo-fonte `kmk/keys.py` (e daí abrir um ticket
|
||||
para nos avisar que os documentos estão desatualizados, ou mesmo abrir um PR
|
||||
|
Loading…
Reference in New Issue
Block a user