diff --git a/docs/en/Getting_Started.md b/docs/en/Getting_Started.md index 12c747f..79c6bc9 100644 --- a/docs/en/Getting_Started.md +++ b/docs/en/Getting_Started.md @@ -4,7 +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). KMK requires CircuitPython version 7.0 or above. Known working and recommended devices can be found [here](Officially_Supported_Microcontrollers.md) -
## TL;DR Quick start guide > To infinity and beyond! @@ -13,7 +12,7 @@ Known working and recommended devices can be found [here](Officially_Supported_M 3. Unzip it and copy the KMK folder and the boot.py file at the root of the USB drive corresponding to your board (often appearing as CIRCUITPY) 4. Create a new *code.py* or *main.py* file in the same root directory (same level as boot.py) with the example content hereunder: -***IMPORTANT:*** adapt the GP0 / GP1 pins to your specific board !
+***IMPORTANT:*** adapt the GP0 / GP1 pins to your specific board ! ``` print("Starting") @@ -45,7 +44,6 @@ if __name__ == '__main__': 6. If it prints the letter "a" (or a "Q" or ... depending on your keyboard layout), you're done! -
## Now that you're up and running, you may want to go further... @@ -56,7 +54,7 @@ If your keyboard and microcontroller are officially supported, simply visit the ### You've got another, maybe DIY, board and want to customize 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 -
Once you've got the gist of it: +Once you've got the gist of it: - You can have a look [here](config_and_keymap.md) and [here](keys.md) to start customizing your code.py / main.py file - There's a [reference](keycodes.md) of the available keycodes - [International](international.md) extension adds keys for non US layouts and [Media Keys](media_keys.md) adds keys for ... media @@ -69,7 +67,6 @@ And to go even further: Want to have fun features such as RGB, split keyboards and more? Check out what builtin [modules](modules.md) and [extensions](extensions.md) can do! You can also get ideas from the various [user examples](https://github.com/KMKfw/kmk_firmware/tree/master/user_keymaps) that we provide and dig into our [documentation](README.md). -
## Additional help and support > Roads? Where we're going we don't need roads. diff --git a/docs/ja/Getting_Started.md b/docs/ja/Getting_Started.md index 6fe51cb..be98c0c 100644 --- a/docs/ja/Getting_Started.md +++ b/docs/ja/Getting_Started.md @@ -9,7 +9,6 @@ KMK は[CircuitPython](https://circuitpython.org/)の上に配置されるキー CircuitPython の最適化バージョン(特定のボードの容量制限に対処した、プリインストールされた関連モジュールの選択が可能なバージョン)も提供しています。 -
## TL;DR クイックスタートガイド > To infinity and beyond! @@ -25,7 +24,7 @@ CircuitPython の最適化バージョン(特定のボードの容量制限に 4. 同じルートディレクトリー(boot.py と同レベル)に新規で*code.py* または *main.py*のファイルを作成する。中身は以下の例とする。 -***重要:*** GP0 / GP1 ピンを使用ボードに合わせて下さい!
+***重要:*** GP0 / GP1 ピンを使用ボードに合わせて下さい ``` @@ -56,8 +55,6 @@ if __name__ == '__main__': 2. "A"や"Q"(キーボードのレイアウトによって異なる)が表示されたら、完成! -
- ## とりあえず一通り動くようになったので、もっとに先へ進みたい場合 > This is your last chance. After this, there is no turning back. You take the blue pill—the story ends, you wake up in your bed and believe whatever you want to believe. You take the red pill—you stay in Wonderland, and I show you how deep the rabbit hole goes. Remember: all I'm offering is the truth. Nothing more. @@ -72,7 +69,7 @@ if __name__ == '__main__': 最初にデバイスの動作や具体的なマトリックス構成についてしっかり理解してください。 QMK チームが提供している手配線キーボード用の[ガイド](https://docs.qmk.fm/#/hand_wire)と[ドキュメント](http://pcbheaven.com/wikipages/How_Key_Matrices_Works/) を確認できます。 -
要旨をつかめてきたら: +要旨をつかめてきたら: - [ここ](config_and_keymap.md) と [ここ](keys.md)を見て、code.py / main.py ファイルをカスタイマイズできます。 - 使用可能なキーコードの[リファレンス](keycodes.md)があります。 @@ -89,7 +86,6 @@ RGB や分裂型などの機能を楽しめたい場合は、ビルトイン[モ 私たちが提供する、いろんな [ユーザー事例](https://github.com/KMKfw/user_keymaps)や[ドキュメント](https://github.com/KMKfw/kmk_firmware/tree/master/docs)からアイデアを得ることもできます。 -
## ヘルプ/サポート > Roads? Where we're going we don't need roads. diff --git a/docs/ptBR/Getting_Started.md b/docs/ptBR/Getting_Started.md index 8527465..c2dd2ba 100644 --- a/docs/ptBR/Getting_Started.md +++ b/docs/ptBR/Getting_Started.md @@ -13,7 +13,6 @@ 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 módulos relevantes pré-instalados). Se você estiver se perguntando por que usar -
## Guia Rápido > Ao Infinito e Além! @@ -30,7 +29,7 @@ módulos relevantes pré-instalados). Se você estiver se perguntando por que us 4. Crie um novo arquivo *code.py* ou *main.py* no mesmo diretório raiz (no mesmo nível de boot.py) com o exemplo contido abaixo: -***IMPORTANTE:*** adapte os pinos GP0 / GP1 para a tua placa específica!
+***IMPORTANTE:*** adapte os pinos GP0 / GP1 para a tua placa específica! ``` print("Starting") @@ -61,7 +60,6 @@ if __name__ == '__main__': 6. Se ela imprimir um "A" (ou um "Q" ou o que depender do teu layout de teclado), você conseguiu! -
## Agora que tudo está no seu lugar, você pode querer ir além... @@ -88,7 +86,7 @@ sua configuração matricial específica. Você pode observar [guia](https://docs.qmk.fm/#/hand_wire) feito pelo time da QMK para teclados artesanais. -
Uma vez que você compreendeu a essência da coisa: +Uma vez que você compreendeu a essência da coisa: - Você pode dar uma olhada [aqui](config_and_keymap.md) e [aqui](keys.md) para começar a customizar seu arquivo code.py / main.py. - Eis uma [referência](keycodes.md) dos códigos de teclas (*keycodes*) @@ -115,7 +113,6 @@ Você também pode obter ideias dos vários [exemplos de usuários](https://github.com/KMKfw/user_keymaps) que fornecemos e fuce nossa [documentação](https://github.com/KMKfw/kmk_firmware/tree/master/docs). -
## Ajuda e Suporte Adicionais > Estradas? Para onde vamos, estradas são desnecessárias.