Remove KMKpython reference
This commit is contained in:
parent
54ae022846
commit
9f2142d706
@ -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
|
||||||
|
@ -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.
|
||||||
|
@ -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)
|
||||||
|
@ -9,8 +9,6 @@ KMKは[CircuitPython](https://circuitpython.org/)の上に配置されるキー
|
|||||||
|
|
||||||
CircuitPython の最適化バージョン(特定のボードの容量制限に対処した、プリインストールされた関連モジュールの選択が可能なバージョン)も提供しています。
|
CircuitPython の最適化バージョン(特定のボードの容量制限に対処した、プリインストールされた関連モジュールの選択が可能なバージョン)も提供しています。
|
||||||
|
|
||||||
なぜCircuitPythonよりKMKPythonを使用するか気になっていたら、両方を比較した[実績](kmkpython_vs_circuitpython.md)があります。
|
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
## TL;DR クイックスタートガイド
|
## TL;DR クイックスタートガイド
|
||||||
@ -67,8 +65,6 @@ 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 を導入したい場合
|
||||||
|
@ -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
|
||||||
|
@ -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
|
||||||
|
@ -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
|
||||||
|
Loading…
x
Reference in New Issue
Block a user