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

Remove KMKpython reference

Browse Source
This commit is contained in:
Kyle Brown 2022-02-27 11:05:11 -08:00
parent 54ae022846
commit 9f2142d706
7 changed files with 19 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/Getting_Started.md
View File

@ -4,8 +4,6 @@
KMK is a keyboard focused layer that sits on top of [CircuitPython](https://circuitpython.org/). As such, it should work with most [boards that support CircuitPython](https://circuitpython.org/downloads). It is best to use the last stable version (>5.0). KMK is a keyboard focused layer that sits on top of [CircuitPython](https://circuitpython.org/). As such, it should work with most [boards that support CircuitPython](https://circuitpython.org/downloads). It is best to use the last stable version (>5.0).
Known working and recommended devices can be found [here](Officially_Supported_Microcontrollers.md) Known working and recommended devices can be found [here](Officially_Supported_Microcontrollers.md)
We are also providing a keyboard optimized version of CircuitPython (simplified to cope with memory limits of certain boards and with a selection of preinstalled relevant modules). If you're wondering why use KMKPython rather than barebone CircuitPython, we tried to compare both approaches [here](kmkpython_vs_circuitpython.md)
<br> <br>
## TL;DR Quick start guide ## TL;DR Quick start guide
@ -55,7 +53,6 @@ if __name__ == '__main__':
### You're extremely lucky and you have a fully supported keyboard ### You're extremely lucky and you have a fully supported keyboard
If your keyboard and microcontroller are officially supported, simply visit the page for your files, and dropping them on the root of the "flash drive". Those pages can be found [here](https://github.com/KMKfw/kmk_firmware/tree/master/boards). You will need the `kb.py` and `main.py`. More advanced instructions can be found [here](config_and_keymap.md). If your keyboard and microcontroller are officially supported, simply visit the page for your files, and dropping them on the root of the "flash drive". Those pages can be found [here](https://github.com/KMKfw/kmk_firmware/tree/master/boards). You will need the `kb.py` and `main.py`. More advanced instructions can be found [here](config_and_keymap.md).
Please note that we recommend using [KMKPython](https://github.com/KMKfw/kmkpython) for these boards as it is optimized for them. If using Circuitpython and NOT KMKPython, you will also need [boot.py](https://github.com/KMKfw/kmk_firmware/blob/master/boot.py)
### You've got another, maybe DIY, board and want to customise KMK for it ### You've got another, maybe DIY, board and want to customise KMK for it
First, be sure to understand how your device work, and particularly its specific matrix configuration. You can have a look [here](http://pcbheaven.com/wikipages/How_Key_Matrices_Works/) or read the [guide](https://docs.qmk.fm/#/hand_wire) provided by the QMK team for handwired keyboards First, be sure to understand how your device work, and particularly its specific matrix configuration. You can have a look [here](http://pcbheaven.com/wikipages/How_Key_Matrices_Works/) or read the [guide](https://docs.qmk.fm/#/hand_wire) provided by the QMK team for handwired keyboards

2
docs/Officially_Supported_Microcontrollers.md
View File

@ -57,6 +57,6 @@ Common Retailers
## Other microcontrollers ## Other microcontrollers
What you'll need to have at minimum What you'll need to have at minimum
- CircuitPython/KMKpython - CircuitPython
- 256KB of flash storage - 256KB of flash storage
- HID over USB and/or Bluetooth. - HID over USB and/or Bluetooth.

1
docs/README.md
View File

@ -18,7 +18,6 @@
- [Flashing instructions](flashing.md) - [Flashing instructions](flashing.md)
- [Handwiring](handwiring.md): Resources helpful when handwiring a keyboard circuit - [Handwiring](handwiring.md): Resources helpful when handwiring a keyboard circuit
- [Keys](keys.md): Technical explanation of key handling - [Keys](keys.md): Technical explanation of key handling
- [KMKPython vs CircuitPython](kmkpython_vs_circuitpython.md)
- [Scanners](scanners.md): Setting up non-default key reading - [Scanners](scanners.md): Setting up non-default key reading
## [Modules](modules.md) ## [Modules](modules.md)

34
docs/ja/Getting_Started.md
View File

@ -1,31 +1,29 @@
# はじめに # はじめに
> Life was like a box of chocolates. You never know what you're gonna get. > Life was like a box of chocolates. You never know what you're gonna get.
KMKは[CircuitPython](https://circuitpython.org/)の上に配置されるキーボード用の実装レイヤーです。 KMK は[CircuitPython](https://circuitpython.org/)の上に配置されるキーボード用の実装レイヤーです。
そのため、[CircuitPythonをサポートするほとんどのボード](https://circuitpython.org/downloads)と互換性があります。 そのため、[CircuitPython をサポートするほとんどのボード](https://circuitpython.org/downloads)と互換性があります。
最新の安定したバージョンを使用することをおすすめします。(>5.0) 最新の安定したバージョンを使用することをおすすめします。(>5.0)
使用可能やおすすめなデバイスは[こちら](Officially_Supported_Microcontrollers.md)から確認できます。 使用可能やおすすめなデバイスは[こちら](Officially_Supported_Microcontrollers.md)から確認できます。
CircuitPythonの最適化バージョン（特定のボードの容量制限に対処した、プリインストールされた関連モジュールの選択が可能なバージョン）も提供しています。 CircuitPython の最適化バージョン（特定のボードの容量制限に対処した、プリインストールされた関連モジュールの選択が可能なバージョン）も提供しています。
なぜCircuitPythonよりKMKPythonを使用するか気になっていたら、両方を比較した[実績](kmkpython_vs_circuitpython.md)があります。
<br> <br>
## TL;DR クイックスタートガイド ## TL;DR クイックスタートガイド
> To infinity and beyond! > To infinity and beyond!
1. CircuitPythonをボードに[インストール](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython)する。 1. CircuitPython をボードに[インストール](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython)する。
2. マスターブランチから[KMKのコピー](https://github.com/KMKfw/kmk_firmware/archive/refs/heads/master.zip)を取得。 2. マスターブランチから[KMK のコピー](https://github.com/KMKfw/kmk_firmware/archive/refs/heads/master.zip)を取得。
3. ファイルを展開し、KMKフォルダーとboot.pyファイルをUSBドライブのルート（CIRCUITPYと表示されることが多い）にコピーする。 3. ファイルを展開し、KMK フォルダーと boot.py ファイルを USB ドライブのルート（CIRCUITPY と表示されることが多い）にコピーする。
4. 同じルートディレクトリー（boot.pyと同レベル）に新規で*code.py* または *main.py*のファイルを作成する。中身は以下の例とする。 4. 同じルートディレクトリー（boot.py と同レベル）に新規で*code.py* または *main.py*のファイルを作成する。中身は以下の例とする。
***重要：*** GP0 / GP1 ピンを使用ボードに合わせて下さい！<br> ***重要：*** GP0 / GP1 ピンを使用ボードに合わせて下さい！<br>
@ -53,7 +51,7 @@ if __name__ == '__main__':
keyboard.go() keyboard.go()
``` ```
1. ワイヤーなどでGPIO 0とGPIO 1（またはほかに指定したピン）を接続する。 1. ワイヤーなどで GPIO 0 と GPIO 1（またはほかに指定したピン）を接続する。
2. "A"や"Q"(キーボードのレイアウトによって異なる)が表示されたら、完成！ 2. "A"や"Q"(キーボードのレイアウトによって異なる)が表示されたら、完成！
@ -67,21 +65,19 @@ if __name__ == '__main__':
### フルサポートされているキーボードを持っている場合 ### フルサポートされているキーボードを持っている場合
あなたのキーボードとマイコンが正式にサポートされている場合、[こちらのページ](https://github.com/KMKfw/boards)から`kb.py` と `main.py`を"flash drive"のルートに落とす必要があります。より高度な手順は[こちら](config_and_keymap.md)から確認できます。 あなたのキーボードとマイコンが正式にサポートされている場合、[こちらのページ](https://github.com/KMKfw/boards)から`kb.py` と `main.py`を"flash drive"のルートに落とす必要があります。より高度な手順は[こちら](config_and_keymap.md)から確認できます。
このボードに最適化されているため、 [KMKPython](https://github.com/KMKfw/kmkpython) の使用を推奨します。 Circuitpython を使用する場合、 [boot.py](https://github.com/KMKfw/kmk_firmware/blob/master/boot.py)も必要になります。
Circuitpythonを使用する場合、 [boot.py](https://github.com/KMKfw/kmk_firmware/blob/master/boot.py)も必要になります。 ### ほかに自作ボードなどを持っていて、カスタマイズされた KMK を導入したい場合
### ほかに自作ボードなどを持っていて、カスタマイズされたKMKを導入したい場合
最初にデバイスの動作や具体的なマトリックス構成についてしっかり理解してください。 最初にデバイスの動作や具体的なマトリックス構成についてしっかり理解してください。
QMKチームが提供している手配線キーボード用の[ガイド](https://docs.qmk.fm/#/hand_wire)と[ドキュメント](http://pcbheaven.com/wikipages/How_Key_Matrices_Works/) を確認できます。 QMK チームが提供している手配線キーボード用の[ガイド](https://docs.qmk.fm/#/hand_wire)と[ドキュメント](http://pcbheaven.com/wikipages/How_Key_Matrices_Works/) を確認できます。
<br>要旨をつかめてきたら： <br>要旨をつかめてきたら：
- [ここ](config_and_keymap.md) と [ここ](keys.md)を見て、code.py / main.py ファイルをカスタイマイズできます。 - [ここ](config_and_keymap.md) と [ここ](keys.md)を見て、code.py / main.py ファイルをカスタイマイズできます。
- 使用可能なキーコードの[リファレンス](keycodes.md)があります。 - 使用可能なキーコードの[リファレンス](keycodes.md)があります。
- [インターナショナル](international.md)は、US配列以外のキーボードにキーを追加する拡張機能で、[メディアキー](media_keys.md)は・・・メディアにキーを追加する拡張機能です。 - [インターナショナル](international.md)は、US 配列以外のキーボードにキーを追加する拡張機能で、[メディアキー](media_keys.md)は・・・メディアにキーを追加する拡張機能です。
さらに先へ進むと： さらに先へ進むと：
- [シーケンス](sequences.md) 一つのアクションで複数のキーストロークを送信するために使用します。 - [シーケンス](sequences.md) 一つのアクションで複数のキーストロークを送信するために使用します。
@ -89,7 +85,7 @@ QMKチームが提供している手配線キーボード用の[ガイド](https
- [モドタップ](modtap.md) でキーの押し/長押しの動作を設定し、何回押されたかによって[タップダンス](tapdance.md)を設定します。 - [モドタップ](modtap.md) でキーの押し/長押しの動作を設定し、何回押されたかによって[タップダンス](tapdance.md)を設定します。
RGBや分裂型などの機能を楽しめたい場合は、ビルトイン[モジュール](modules.md)と[拡張機能](extensions.md)を見てみてください！ RGB や分裂型などの機能を楽しめたい場合は、ビルトイン[モジュール](modules.md)と[拡張機能](extensions.md)を見てみてください！
私たちが提供する、いろんな [ユーザー事例](https://github.com/KMKfw/user_keymaps)や[ドキュメント](https://github.com/KMKfw/kmk_firmware/tree/master/docs)からアイデアを得ることもできます。 私たちが提供する、いろんな [ユーザー事例](https://github.com/KMKfw/user_keymaps)や[ドキュメント](https://github.com/KMKfw/kmk_firmware/tree/master/docs)からアイデアを得ることもできます。
@ -100,10 +96,10 @@ RGBや分裂型などの機能を楽しめたい場合は、ビルトイン[モ
デバッグについてのヘルプが必要な場合は[こちら](debugging.md)。 デバッグについてのヘルプが必要な場合は[こちら](debugging.md)。
KMKについてサポートが必要な場合や、コミュニケーションをとりたい場合は[こちら](https://matrix.to/#/#kmkfw:klar.sh)。 KMK についてサポートが必要な場合や、コミュニケーションをとりたい場合は[こちら](https://matrix.to/#/#kmkfw:klar.sh)。
このチャネルは[Discord](https://discordapp.com/widget?id=493256121075761173&theme=dark) からも見ることができます。 このチャネルは[Discord](https://discordapp.com/widget?id=493256121075761173&theme=dark) からも見ることができます。
チャットやバグ報告などでヘルプを求める場合、可能な限り、コントローラーのREPLに`from kmk.consts import KMK_RELEASE; print(KMK_RELEASE)`を実行することによって表示されるコミットSHAを記載してください。 チャットやバグ報告などでヘルプを求める場合、可能な限り、コントローラーの REPL に`from kmk.consts import KMK_RELEASE; print(KMK_RELEASE)`を実行することによって表示されるコミットSHAを記載してください。

2
docs/kmkpython_vs_circuitpython.md
View File

@ -1,3 +1,5 @@
# THIS IS OUT OF DATE. DO NOT USE. ONLY FOR REFERENCE
## Firmware of choice ## Firmware of choice
### KMKPython ### KMKPython
KMKPython is a fork of Circuitpython, but with libraries for most extensions KMKPython is a fork of Circuitpython, but with libraries for most extensions

7
docs/ptBR/Getting_Started.md
View File

@ -12,8 +12,6 @@ encontrados [aqui](Officially_Supported_Microcontrollers.md)
Também fornecemos uma versão de CircuitPython otimizada para teclados Também fornecemos uma versão de CircuitPython otimizada para teclados
(simplificada para lidar com os limites de certas placas e com a seleção dos (simplificada para lidar com os limites de certas placas e com a seleção dos
módulos relevantes pré-instalados). Se você estiver se perguntando por que usar módulos relevantes pré-instalados). Se você estiver se perguntando por que usar
KMKPython em vez do CircuitPython cru, tentamos comparar ambas as abordagens
[aqui](kmkpython_vs_circuitpython.md)
<br> <br>
@ -82,11 +80,6 @@ Estas webpages podem ser vistas [aqui](https://github.com/KMKfw/boards). Você
precisará dos arquivos `kb.py` e `main.py`. Instruções mais avançadas podem ser precisará dos arquivos `kb.py` e `main.py`. Instruções mais avançadas podem ser
vistas [aqui](config_and_keymap.md). vistas [aqui](config_and_keymap.md).
Note que recomendamos utilizar [KMKPython](https://github.com/KMKfw/kmkpython)
para essas placas pois ele é otimizado para elas. Se você usar o Circuitpython
em vez do KMKPython, você também vai precisar do
[boot.py](https://github.com/KMKfw/kmk_firmware/blob/master/boot.py).
### Você obteve outro teclado, possivelmente artesanal, e quer customizar o KMK para ele ### Você obteve outro teclado, possivelmente artesanal, e quer customizar o KMK para ele
Primeiro, certifique-se de entender como o seu teclado funciona, e em particular Primeiro, certifique-se de entender como o seu teclado funciona, e em particular

2
docs/ptBR/ble_hid.md
View File

@ -4,7 +4,7 @@ Conexões Bluetooth ajudam a se livrar da maçaroca de fios!
## Circuitpython ## Circuitpython
Se não estiver usando o KMKPython, você precisará da biblioteca `adafruit_ble` Se não estiver usando, você precisará da biblioteca `adafruit_ble`
da Adafruit. Ela pode ser baixada da Adafruit. Ela pode ser baixada
[aqui](https://github.com/adafruit/Adafruit_CircuitPython_BLE/tree/master/adafruit_ble). [aqui](https://github.com/adafruit/Adafruit_CircuitPython_BLE/tree/master/adafruit_ble).
Ela faz parte do [Pacotão Adafruit Ela faz parte do [Pacotão Adafruit