diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/arm_debugging.md | 22 | ||||
| -rw-r--r-- | docs/fr-fr/getting_started_github.md | 22 | ||||
| -rw-r--r-- | docs/fr-fr/getting_started_introduction.md | 2 | ||||
| -rw-r--r-- | docs/getting_started_github.md | 20 | ||||
| -rw-r--r-- | docs/he-il/getting_started_github.md | 24 | ||||
| -rw-r--r-- | docs/he-il/getting_started_introduction.md | 4 | ||||
| -rw-r--r-- | docs/ja/arm_debugging.md | 20 | ||||
| -rw-r--r-- | docs/ja/getting_started_github.md | 20 | ||||
| -rw-r--r-- | docs/ru-ru/getting_started_github.md | 22 | ||||
| -rw-r--r-- | docs/ru-ru/getting_started_introduction.md | 2 | ||||
| -rw-r--r-- | docs/zh-cn/getting_started_github.md | 22 | ||||
| -rw-r--r-- | docs/zh-cn/getting_started_introduction.md | 2 |
12 files changed, 109 insertions, 73 deletions
diff --git a/docs/arm_debugging.md b/docs/arm_debugging.md index 448b7a8fcc..04887d88b7 100644 --- a/docs/arm_debugging.md +++ b/docs/arm_debugging.md @@ -1,4 +1,4 @@ -# ARM Debugging usign Eclipse +# ARM Debugging using Eclipse This page describes how to setup debugging for ARM MCUs using an SWD adapter and open-source/free tools. In this guide we will install GNU MCU Eclipse IDE for C/C++ Developers and OpenOCD together with all the necessary dependencies. @@ -18,7 +18,7 @@ XPM installation instructions can be found [here](https://www.npmjs.com/package/ ### The ARM Toolchain -Using XPM it is very easy to install the ARM toolchain. Enter the command `xpm install --global @gnu-mcu-eclipse/arm-none-eabi-gcc`. +Using XPM it is very easy to install the ARM toolchain. Enter the command `xpm install --global @xpack-dev-tools/arm-none-eabi-gcc`. ### Windows build tools @@ -33,7 +33,7 @@ If you have an ST-Link the drivers can be found [here](https://www.st.com/en/dev ### OpenOCD -This dependency allows SWD access from GDB and it is essential for debugging. Run `xpm install --global @gnu-mcu-eclipse/openocd`. +This dependency allows SWD access from GDB and it is essential for debugging. Run `xpm install --global @xpack-dev-tools/openocd`. ### Java @@ -45,17 +45,17 @@ Now its finally time to install the IDE. Use the Release page [here](https://git ## Configuring Eclipse -Open up the Eclipse IDE we just downloaded. To import our QMK directory select File -> Import -> C/C++ -> Existing code as Makefile Project. Select next and use Browse to select your QMK folder. In the tool-chain list select ARM Cross GCC and select Finish. +Open up the Eclipse IDE we just downloaded. To import our QMK directory select File -> Import -> C/C++ -> Existing Code as Makefile Project. Select Next and use Browse to select your QMK folder. In the tool-chain list select ARM Cross GCC and select Finish. -Now you can see the QMK folder on the left hand side. Right click it and select Properties. On the left hand side, expand MCU and select ARM Toolchain Paths. Press xPack and OK. Repeat for OpenOCD Path and if you are on windows for Build Tool Path. Select Apply and Close. +Now you can see the QMK folder on the left hand side. Right click it and select Properties. On the left hand side, expand MCU and select ARM Toolchains Paths. Press xPack and OK. Repeat for OpenOCD Path and if you are on Windows for Build Tools Path. Select Apply and Close. -Now its time to install the necessary MCU packages. Go to Packs perspective by selecting Window -> Open Perspective -> Others -> Packs. Now select the yellow refresh symbol next to the Packs tab. This will take a long time as it is requesting the MCU definitions from various places. If some of the links fail you can probably select Ignore. +Now its time to install the necessary MCU packages. Go to Packs perspective by selecting Window -> Perspective -> Open Perspective -> Other... -> Packs. Now select the yellow refresh symbol next to the Packs tab. This will take a long time as it is requesting the MCU definitions from various places. If some of the links fail you can probably select Ignore. -When this finishes you must find the MCU which we will be building/debugging for. In this example I will be using the STM32F3 series MCUs. On the left, select STMicroelectonics -> STM32F3 Series. On the middle window we can see the pack. Right click and select Install. Once that is done we can go back to the default perspective, Window -> Open Perspective -> Others -> C/C++. +When this finishes you must find the MCU which we will be building/debugging for. In this example I will be using the STM32F3 series MCUs. On the left, select STMicroelectronics -> STM32F3 Series. On the middle window we can see the pack. Right click and select Install. Once that is done we can go back to the default perspective, Window -> Perspective -> Open Perspective -> Other... -> C/C++. -We need to let eclipse know the device we intent to build QMK on. Right click on the QMK folder -> Properties -> C/C++ Build -> Settings. Select the Devices tab and under devices select the appropriate variant of your MCU. For my example it is STM32F303CC +We need to let eclipse know the device we intent to build QMK on. Right click on the QMK folder -> Properties -> C/C++ Build -> Settings. Select the Devices tab and under Devices select the appropriate variant of your MCU. For my example it is STM32F303CC -While we are here let's setup the build command as well. Select C/C++ Build and then the Behavior tab. On the build command, replace `all` with your necessary make command. For example for a rev6 Planck with the default keymap this would be `planck/rev6:default`. Select Apply and Close. +While we are here let's setup the build command as well. Select C/C++ Build and then the Behavior tab. On the Build command, replace `all` with your necessary make command. For example for a rev6 Planck with the default keymap this would be `planck/rev6:default`. Select Apply and Close. ## Building @@ -71,7 +71,7 @@ NOTE: Make sure the SWCLK and SWDIO pins are not used in the matrix of your keyb ### Configuring the Debugger -Right click on your QMK folder, select Debug As -> Debug Configuration. Here double click on GDB OpenOCD Debugging. Select the debugger tab and enter the configuration necessary for your MCU. This might take some fiddling and googleing to find out. The default script for the STM32F3 is called stm32f3discovery.cfg. To let OpenOCD know, in the Config options enter `-f board/stm32f3discovery.cfg`. +Right click on your QMK folder, select Debug As -> Debug Configurations... . Here double click on GDB OpenOCD Debugging. Select the Debugger tab and enter the configuration necessary for your MCU. This might take some fiddling and Googling to find out. The default script for the STM32F3 is called `stm32f3discovery.cfg`. To let OpenOCD know, in the Config options enter `-f board/stm32f3discovery.cfg`. NOTE: In my case this configuration script requires editing to disable the reset assertion. The locations of the scripts can be found in the actual executable field usually under the path `openocd/version/.content/scripts/board`. Here I edited `reset_config srst_only` to `reset_config none`. @@ -81,7 +81,7 @@ Select Apply and Close. Reset your keyboard. -Press the bug icon and if all goes well you should soon find yourself in the debug perspective. Here the program counter will pause at the beginning of the main function and way for you to press Play. Most of the features of all debuggers work on ARM MCUs but for exact details google is your friend! +Press the bug icon and if all goes well you should soon find yourself in the Debug perspective. Here the program counter will pause at the beginning of the main function and wait for you to press Play. Most of the features of all debuggers work on Arm MCUs but for exact details Google is your friend! Happy debugging! diff --git a/docs/fr-fr/getting_started_github.md b/docs/fr-fr/getting_started_github.md index 22c6ee749b..48755625a7 100644 --- a/docs/fr-fr/getting_started_github.md +++ b/docs/fr-fr/getting_started_github.md @@ -16,17 +16,23 @@ Faites attention à sélectionner "HTTPS", et sélectionnez le lien et copiez-le  -Ensuite, entrez `git clone` dans la ligne de commande, et collez votre lien: +Ensuite, entrez `git clone --recurse-submodules ` dans la ligne de commande, et collez votre lien: ``` -user@computer:~$ git clone https://github.com/whoeveryouare/qmk_firmware.git +user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git Cloning into 'qmk_firmware'... -remote: Counting objects: 46625, done. -remote: Compressing objects: 100% (2/2), done. -remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623 -Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. -Resolving deltas: 100% (29362/29362), done. -Checking out files: 100% (2799/2799), done. +remote: Enumerating objects: 9, done. +remote: Counting objects: 100% (9/9), done. +remote: Compressing objects: 100% (5/5), done. +remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 +Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. +Resolving deltas: 100% (119972/119972), done. +... +Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' +Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' +Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' +Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' +Submodule path 'lib/ugfx': checked out '3e97b74e03c93631cdd3ddb2ce43b963fdce19b2' ``` Vous avez maintenant votre fork QMK sur votre machine locale, vous pouvez ajouter votre keymap, la compiler et la flasher sur votre board. Une fois heureux avec vos changements, vous pouvez les ajouter, commit, et pousser vers votre fork comme suit: diff --git a/docs/fr-fr/getting_started_introduction.md b/docs/fr-fr/getting_started_introduction.md index a7f0ff96af..b2711a1671 100644 --- a/docs/fr-fr/getting_started_introduction.md +++ b/docs/fr-fr/getting_started_introduction.md @@ -4,7 +4,7 @@ Le but de cette page est d'expliquer les informations de base qui vous serons nà ## Structure de base de QMK -QMK est un fork du projet [tmk_keyboard](https://github.com/tmk/tmk_keyboard) créé par [Jun Wako](https://github.com/tmk). Le code originel de TMK, avec quelques modifications, se trouve dans le dossier `tmk`. Les additions que QMK amène au projet se trouvent dans le dossier `quantum`. Les projets de clavier se trouvent dans les dossiers `handwired` et `keyboard`. +QMK est un fork du projet [tmk_keyboard](https://github.com/tmk/tmk_keyboard) créé par [Jun Wako](https://github.com/tmk). Le code originel de TMK, avec quelques modifications, se trouve dans le dossier `tmk_core`. Les additions que QMK amène au projet se trouvent dans le dossier `quantum`. Les projets de clavier se trouvent dans les dossiers `handwired` et `keyboard`. ### Structure du Userspace diff --git a/docs/getting_started_github.md b/docs/getting_started_github.md index 629f4ece26..07f523f578 100644 --- a/docs/getting_started_github.md +++ b/docs/getting_started_github.md @@ -16,17 +16,23 @@ And be sure to select "HTTPS", and select the link and copy it:  -From here, enter `git clone ` into the command line, and then paste your link: +From here, enter `git clone --recurse-submodules ` into the command line, and then paste your link: ``` user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git Cloning into 'qmk_firmware'... -remote: Counting objects: 46625, done. -remote: Compressing objects: 100% (2/2), done. -remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623 -Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. -Resolving deltas: 100% (29362/29362), done. -Checking out files: 100% (2799/2799), done. +remote: Enumerating objects: 9, done. +remote: Counting objects: 100% (9/9), done. +remote: Compressing objects: 100% (5/5), done. +remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 +Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. +Resolving deltas: 100% (119972/119972), done. +... +Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' +Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' +Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' +Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' +Submodule path 'lib/ugfx': checked out '3e97b74e03c93631cdd3ddb2ce43b963fdce19b2' ``` You now have your QMK fork on your local machine, and you can add your keymap, compile it and flash it to your board. Once you're happy with your changes, you can add, commit, and push them to your fork like this: diff --git a/docs/he-il/getting_started_github.md b/docs/he-il/getting_started_github.md index 55602c8142..e5d0f7c782 100644 --- a/docs/he-il/getting_started_github.md +++ b/docs/he-il/getting_started_github.md @@ -17,19 +17,25 @@ Github עלול להיות קצת טריקי למי ×©×œ× ×ž×›×™×¨ ×ת ×”×¢×‘×  -מכ×ן והל××”, הקיש `git clone ` בשורת הפקודה והדביקו ×ת ×”×œ×™× ×§ שלכ×: +מכ×ן והל××”, הקיש `git clone --recurse-submodules ` בשורת הפקודה והדביקו ×ת ×”×œ×™× ×§ שלכ×: <div dir="ltr" markdown="1"> ``` -user@computer:~$ git clone https://github.com/whoeveryouare/qmk_firmware.git +user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git Cloning into 'qmk_firmware'... -remote: Counting objects: 46625, done. -remote: Compressing objects: 100% (2/2), done. -remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623 -Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. -Resolving deltas: 100% (29362/29362), done. -Checking out files: 100% (2799/2799), done. +remote: Enumerating objects: 9, done. +remote: Counting objects: 100% (9/9), done. +remote: Compressing objects: 100% (5/5), done. +remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 +Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. +Resolving deltas: 100% (119972/119972), done. +... +Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' +Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' +Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' +Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' +Submodule path 'lib/ugfx': checked out '3e97b74e03c93631cdd3ddb2ce43b963fdce19b2' ``` </div> @@ -66,4 +72,4 @@ To https://github.com/whoeveryouare/qmk_firmware.git  ×חרי שהגשת×, ×× ×• ×¢×œ×•×œ×™× ×œ×¤× ×•×ª ××œ×™×›× ×œ×’×‘×™ ×”×©×™× ×•×™×™× ×©×”×¦×¢×ª×, × ×‘×§×© שתבצעו ×©×™× ×•×™×™× ×•×‘×¡×•×¤×• של דבר × ×§×‘×œ ×ת ×”×©×™× ×•×™×™×! תודה ×©×ª×¨×ž×ª× ×œ×¤×¨×•×™×™×§×˜ QMK :) -</div>
\ No newline at end of file +</div> diff --git a/docs/he-il/getting_started_introduction.md b/docs/he-il/getting_started_introduction.md index 4b7f56b2a7..fca86bdaaf 100644 --- a/docs/he-il/getting_started_introduction.md +++ b/docs/he-il/getting_started_introduction.md @@ -5,7 +5,7 @@ ## ×ž×‘× ×” QMK בסיסי -QMK ×”×•× ×¤×•×¨×§ של הפרוייקט [tmk_keyboard](https://github.com/tmk/tmk_keyboard) של [Jun Wako](https://github.com/tmk). קוד ×”TMK המקורי, ×¢× ×”×ª×מות, יכול ×œ×”×ž×¦× ×‘×ª×™×§×™×™×ª `tmk`. התוספות של QMK לפרוייקט יכולות ×œ×”×ž×¦× ×‘×ª×™×§×™×™×ª `quantum`. פרוייקטי מקלדות יכולות ×œ×”×ž×¦× ×‘×ª×™×§×™×•×ª `handwired` ו- `keyboard`. +QMK ×”×•× ×¤×•×¨×§ של הפרוייקט [tmk_keyboard](https://github.com/tmk/tmk_keyboard) של [Jun Wako](https://github.com/tmk). קוד ×”TMK המקורי, ×¢× ×”×ª×מות, יכול ×œ×”×ž×¦× ×‘×ª×™×§×™×™×ª `tmk_core`. התוספות של QMK לפרוייקט יכולות ×œ×”×ž×¦× ×‘×ª×™×§×™×™×ª `quantum`. פרוייקטי מקלדות יכולות ×œ×”×ž×¦× ×‘×ª×™×§×™×•×ª `handwired` ו- `keyboard`. ### ×ž×‘× ×” ×חסון המשתמש @@ -69,4 +69,4 @@ In every keymap folder, the following files may be found. Only `keymap.c` is req ``` </div> -</div>
\ No newline at end of file +</div> diff --git a/docs/ja/arm_debugging.md b/docs/ja/arm_debugging.md index 5b7b89a678..27eddbfdf1 100644 --- a/docs/ja/arm_debugging.md +++ b/docs/ja/arm_debugging.md @@ -23,7 +23,7 @@ XPM ã®ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«æ‰‹é †ã¯[ã“ã“](https://www.npmjs.com/package/xpm)㧠### ARM ツールãƒã‚§ãƒ¼ãƒ³ -XPM を使ã†ã¨ã€ARM ツールãƒã‚§ãƒ¼ãƒ³ã‚’ã¨ã¦ã‚‚ç°¡å˜ã«ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã§ãã¾ã™ã€‚`xpm install --global @gnu-mcu-eclipse/arm-none-eabi-gcc` ã¨ã‚³ãƒžãƒ³ãƒ‰ã‚’入力ã—ã¾ã™ã€‚ +XPM を使ã†ã¨ã€ARM ツールãƒã‚§ãƒ¼ãƒ³ã‚’ã¨ã¦ã‚‚ç°¡å˜ã«ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã§ãã¾ã™ã€‚`xpm install --global @xpack-dev-tools/arm-none-eabi-gcc` ã¨ã‚³ãƒžãƒ³ãƒ‰ã‚’入力ã—ã¾ã™ã€‚ ### Windows ビルドツール @@ -38,7 +38,7 @@ ST-Link ã‚’æŒã£ã¦ã„ã‚‹å ´åˆã¯ã€ãƒ‰ãƒ©ã‚¤ãƒã¯[ã“ã“](https://www.st.com ### OpenOCD -ã“ã®ä¾å˜é–¢ä¿‚ã«ã‚ˆã‚Šã€SWD 㯠GDB ã‹ã‚‰ã‚¢ã‚¯ã‚»ã‚¹ã§ãã€ãƒ‡ãƒãƒƒã‚°ã«ä¸å¯æ¬ ã§ã™ã€‚`xpm install --global @gnu-mcu-eclipse/openocd` を実行ã—ã¾ã™ã€‚ +ã“ã®ä¾å˜é–¢ä¿‚ã«ã‚ˆã‚Šã€SWD 㯠GDB ã‹ã‚‰ã‚¢ã‚¯ã‚»ã‚¹ã§ãã€ãƒ‡ãƒãƒƒã‚°ã«ä¸å¯æ¬ ã§ã™ã€‚`xpm install --global @xpack-dev-tools/openocd` を実行ã—ã¾ã™ã€‚ ### Java @@ -50,17 +50,17 @@ Java 㯠Eclipse ã§å¿…è¦ã¨ã•ã‚Œã‚‹ãŸã‚ã€[ã“ã“](https://www.oracle.com/t ## Eclipse ã®è¨å®š -ダウンãƒãƒ¼ãƒ‰ã—㟠Eclipse IDE ã‚’é–‹ãã¾ã™ã€‚QMK ディレクトリをインãƒãƒ¼ãƒˆã™ã‚‹ãŸã‚ã«ã€File -> Import -> C/C++ -> Existing code as Makefile Project ã‚’é¸æŠžã—ã¾ã™ã€‚Next ã‚’é¸æŠžã—ã€Browse を使用ã—㦠QMK フォルダをé¸æŠžã—ã¾ã™ã€‚tool-chain リストã‹ã‚‰ ARM Cross GCC ã‚’é¸æŠžã—ã€Finish ã‚’é¸æŠžã—ã¾ã™ã€‚ +ダウンãƒãƒ¼ãƒ‰ã—㟠Eclipse IDE ã‚’é–‹ãã¾ã™ã€‚QMK ディレクトリをインãƒãƒ¼ãƒˆã™ã‚‹ãŸã‚ã«ã€File -> Import -> C/C++ -> Existing Code as Makefile Project ã‚’é¸æŠžã—ã¾ã™ã€‚Next ã‚’é¸æŠžã—ã€Browse を使用ã—㦠QMK フォルダをé¸æŠžã—ã¾ã™ã€‚tool-chain リストã‹ã‚‰ ARM Cross GCC ã‚’é¸æŠžã—ã€Finish ã‚’é¸æŠžã—ã¾ã™ã€‚ -ã“ã‚Œã§ã€å·¦å´ã« QMK フォルダãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚å³ã‚¯ãƒªãƒƒã‚¯ã—ã¦ã€Properties ã‚’é¸æŠžã—ã¾ã™ã€‚å·¦å´ã§ MCU を展開ã—ã€ARM Toolchain Paths ã‚’é¸æŠžã—ã¾ã™ã€‚xPack を押ã—㦠OK を押ã—ã¾ã™ã€‚OpenOCD Path ã§åŒã˜ã“ã¨ã‚’ç¹°ã‚Šè¿”ã—ã€Windows ã®å ´åˆã¯ã€Build Tool Path ã§ã‚‚åŒã˜ã“ã¨ã‚’ç¹°ã‚Šè¿”ã—ã¾ã™ã€‚Apply and Close ã‚’é¸æŠžã—ã¾ã™ã€‚ +ã“ã‚Œã§ã€å·¦å´ã« QMK フォルダãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚å³ã‚¯ãƒªãƒƒã‚¯ã—ã¦ã€Properties ã‚’é¸æŠžã—ã¾ã™ã€‚å·¦å´ã§ MCU を展開ã—ã€ARM Toolchains Paths ã‚’é¸æŠžã—ã¾ã™ã€‚xPack を押ã—㦠OK を押ã—ã¾ã™ã€‚OpenOCD Path ã§åŒã˜ã“ã¨ã‚’ç¹°ã‚Šè¿”ã—ã€Windows ã®å ´åˆã¯ã€Build Tools Path ã§ã‚‚åŒã˜ã“ã¨ã‚’ç¹°ã‚Šè¿”ã—ã¾ã™ã€‚Apply and Close ã‚’é¸æŠžã—ã¾ã™ã€‚ -ã“ã“ã§ã€å¿…è¦ãª MCU パッケージをインストールã—ã¾ã™ã€‚Window -> Open Perspective -> Others -> Packs ã‚’é¸æŠžã—ã¦ã€Packs perspective ã«ç§»å‹•ã—ã¾ã™ã€‚Packs タブã®æ¨ªã«ã‚る黄色ã®ãƒªãƒ•ãƒ¬ãƒƒã‚·ãƒ¥è¨˜å·ã‚’é¸æŠžã—ã¾ã™ã€‚ã“ã‚Œã¯æ§˜ã€…ãªå ´æ‰€ã‹ã‚‰ MCU ã®å®šç¾©ã‚’è¦æ±‚ã™ã‚‹ãŸã‚ã€æ™‚é–“ãŒæŽ›ã‹ã‚Šã¾ã™ã€‚一部ã®ãƒªãƒ³ã‚¯ãŒå¤±æ•—ã—ãŸå ´åˆã¯ã€ãŠãらã Ignore ã‚’é¸æŠžã§ãã¾ã™ã€‚ +ã“ã“ã§ã€å¿…è¦ãª MCU パッケージをインストールã—ã¾ã™ã€‚Window -> Perspective -> Open Perspective -> Other... -> Packs ã‚’é¸æŠžã—ã¦ã€Packs perspective ã«ç§»å‹•ã—ã¾ã™ã€‚Packs タブã®æ¨ªã«ã‚る黄色ã®ãƒªãƒ•ãƒ¬ãƒƒã‚·ãƒ¥è¨˜å·ã‚’é¸æŠžã—ã¾ã™ã€‚ã“ã‚Œã¯æ§˜ã€…ãªå ´æ‰€ã‹ã‚‰ MCU ã®å®šç¾©ã‚’è¦æ±‚ã™ã‚‹ãŸã‚ã€æ™‚é–“ãŒæŽ›ã‹ã‚Šã¾ã™ã€‚一部ã®ãƒªãƒ³ã‚¯ãŒå¤±æ•—ã—ãŸå ´åˆã¯ã€ãŠãらã Ignore ã‚’é¸æŠžã§ãã¾ã™ã€‚ -ã“ã‚ŒãŒçµ‚了ã™ã‚‹ã¨ã€ãƒ“ルドやデãƒãƒƒã‚°ã™ã‚‹ MCU を見ã¤ã‘ã‚‹ã“ã¨ãŒã§ãã‚‹ã¯ãšã§ã™ã€‚ã“ã®ä¾‹ã§ã¯ã€STM32F3 シリーズ㮠MCU を使ã„ã¾ã™ã€‚å·¦å´ã§ã€STMicroelectronics -> STM32F3 Series ã‚’é¸æŠžã—ã¾ã™ã€‚ä¸å¤®ã®ã‚¦ã‚£ãƒ³ãƒ‰ã‚¦ã«ã€pack ãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚å³ã‚¯ãƒªãƒƒã‚¯ã—ã€Install ã‚’é¸æŠžã—ã¾ã™ã€‚ãã‚ŒãŒçµ‚了ã—ãŸã‚‰ã€Window -> Open Perspective -> Others -> C/C++ ã‚’é¸æŠžã—ã¦ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®ãƒ‘ースペクティブã«æˆ»ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ +ã“ã‚ŒãŒçµ‚了ã™ã‚‹ã¨ã€ãƒ“ルドやデãƒãƒƒã‚°ã™ã‚‹ MCU を見ã¤ã‘ã‚‹ã“ã¨ãŒã§ãã‚‹ã¯ãšã§ã™ã€‚ã“ã®ä¾‹ã§ã¯ã€STM32F3 シリーズ㮠MCU を使ã„ã¾ã™ã€‚å·¦å´ã§ã€STMicroelectronics -> STM32F3 Series ã‚’é¸æŠžã—ã¾ã™ã€‚ä¸å¤®ã®ã‚¦ã‚£ãƒ³ãƒ‰ã‚¦ã«ã€pack ãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚å³ã‚¯ãƒªãƒƒã‚¯ã—ã€Install ã‚’é¸æŠžã—ã¾ã™ã€‚ãã‚ŒãŒçµ‚了ã—ãŸã‚‰ã€Window -> Perspective -> Open Perspective -> Other... -> C/C++ ã‚’é¸æŠžã—ã¦ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®ãƒ‘ースペクティブã«æˆ»ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ -Eclipse ã« QMK をビルドã—よã†ã¨ã™ã‚‹ãƒ‡ãƒã‚¤ã‚¹ã‚’æ•™ãˆã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚QMK フォルダをå³ã‚¯ãƒªãƒƒã‚¯ -> Properties -> C/C++ Build -> Settings ã‚’é¸æŠžã—ã¾ã™ã€‚Devices タブをé¸æŠžã—ã€devices ã®ä¸‹ã‹ã‚‰ MCU ã®é©åˆ‡ãªç¨®é¡žã‚’é¸æŠžã—ã¾ã™ã€‚ç§ã®ä¾‹ã§ã¯ã€STM32F303CC ã§ã™ã€‚ +Eclipse ã« QMK をビルドã—よã†ã¨ã™ã‚‹ãƒ‡ãƒã‚¤ã‚¹ã‚’æ•™ãˆã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚QMK フォルダをå³ã‚¯ãƒªãƒƒã‚¯ -> Properties -> C/C++ Build -> Settings ã‚’é¸æŠžã—ã¾ã™ã€‚Devices タブをé¸æŠžã—ã€Devices ã®ä¸‹ã‹ã‚‰ MCU ã®é©åˆ‡ãªç¨®é¡žã‚’é¸æŠžã—ã¾ã™ã€‚ç§ã®ä¾‹ã§ã¯ã€STM32F303CC ã§ã™ã€‚ -ã“ã®é–“ã«ã€build コマンドもセットアップã—ã¾ã—ょã†ã€‚C/C++ Build ã‚’é¸æŠžã—ã€Behavior タブをé¸æŠžã—ã¾ã™ã€‚build コマンドã®ã¨ã“ã‚ã§ã€`all` ã‚’å¿…è¦ãª make コマンドã«ç½®ãæ›ãˆã¾ã™ã€‚例ãˆã°ã€rev6 Planck ã® default ã‚ーマップã®å ´åˆã€ã“れ㯠`planck/rev6:default` ã«ãªã‚Šã¾ã™ã€‚Apply and Close ã‚’é¸æŠžã—ã¾ã™ã€‚ +ã“ã®é–“ã«ã€Build コマンドもセットアップã—ã¾ã—ょã†ã€‚C/C++ Build ã‚’é¸æŠžã—ã€Behavior タブをé¸æŠžã—ã¾ã™ã€‚build コマンドã®ã¨ã“ã‚ã§ã€`all` ã‚’å¿…è¦ãª make コマンドã«ç½®ãæ›ãˆã¾ã™ã€‚例ãˆã°ã€rev6 Planck ã® default ã‚ーマップã®å ´åˆã€ã“れ㯠`planck/rev6:default` ã«ãªã‚Šã¾ã™ã€‚Apply and Close ã‚’é¸æŠžã—ã¾ã™ã€‚ ## ビルド @@ -76,7 +76,7 @@ ARM MCU ã¯ã€ã‚¯ãƒãƒƒã‚¯ä¿¡å·(SWCLK) ã¨ãƒ‡ãƒ¼ã‚¿ä¿¡å·(SWDIO) ã§æ§‹æˆã•ã‚ ### デãƒãƒƒã‚¬ã®è¨å®š -QMK フォルダをå³ã‚¯ãƒªãƒƒã‚¯ã—ã€Debug As -> Debug Configuration ã‚’é¸æŠžã—ã¾ã™ã€‚ã“ã“ã§ã€GDB OpenOCD Debugging をダブルクリックã—ã¾ã™ã€‚Debugger タブをé¸æŠžã—ã€MCU ã«å¿…è¦ãªè¨å®šã‚’入力ã—ã¾ã™ã€‚ã“れを見ã¤ã‘ã‚‹ã«ã¯ã„ã˜ã£ãŸã‚Šã‚°ã‚°ã£ãŸã‚Šã™ã‚‹å¿…è¦ãŒã‚ã‚‹ã‹ã‚‚ã—ã‚Œã¾ã›ã‚“。STM32F3 用ã®ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã‚¹ã‚¯ãƒªãƒ—ト㯠stm32f3discovery.cfg ã¨å‘¼ã°ã‚Œã¾ã™ã€‚OpenOCD ã«ä¼ãˆã‚‹ã«ã¯ã€Config options 㧠`-f board/stm32f3discovery.cfg` ã¨å…¥åŠ›ã—ã¾ã™ã€‚ +QMK フォルダをå³ã‚¯ãƒªãƒƒã‚¯ã—ã€Debug As -> Debug Configurations... ã‚’é¸æŠžã—ã¾ã™ã€‚ã“ã“ã§ã€GDB OpenOCD Debugging をダブルクリックã—ã¾ã™ã€‚Debugger タブをé¸æŠžã—ã€MCU ã«å¿…è¦ãªè¨å®šã‚’入力ã—ã¾ã™ã€‚ã“れを見ã¤ã‘ã‚‹ã«ã¯ã„ã˜ã£ãŸã‚Šã‚°ã‚°ã£ãŸã‚Šã™ã‚‹å¿…è¦ãŒã‚ã‚‹ã‹ã‚‚ã—ã‚Œã¾ã›ã‚“。STM32F3 用ã®ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã‚¹ã‚¯ãƒªãƒ—ト㯠stm32f3discovery.cfg ã¨å‘¼ã°ã‚Œã¾ã™ã€‚OpenOCD ã«ä¼ãˆã‚‹ã«ã¯ã€Config options 㧠`-f board/stm32f3discovery.cfg` ã¨å…¥åŠ›ã—ã¾ã™ã€‚ 注æ„: ç§ã®å ´åˆã€ã“ã®è¨å®šã‚¹ã‚¯ãƒªãƒ—トã¯ãƒªã‚»ãƒƒãƒˆæ“作を無効ã«ã™ã‚‹ãŸã‚ã«ç·¨é›†ãŒå¿…è¦ã§ã™ã€‚スクリプトã®å ´æ‰€ã¯ã€é€šå¸¸ã¯ãƒ‘ス `openocd/version/.content/scripts/board` ã®ä¸‹ã®å®Ÿéš›ã®å®Ÿè¡Œå¯èƒ½ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã®ä¸ã§è¦‹ã¤ã‹ã‚Šã¾ã™ã€‚ã“ã“ã§ã€ç§ã¯ `reset_config srst_only` ã‚’ `reset_config none` ã«ç·¨é›†ã—ã¾ã—ãŸã€‚ @@ -86,7 +86,7 @@ Apply and Close ã‚’é¸æŠžã—ã¾ã™ã€‚ ã‚ーボードをリセットã—ã¦ãã ã•ã„。 -虫アイコンをクリックã—ã€ã‚‚ã—å…¨ã¦ã†ã¾ãè¡Œã‘ã° debug パースペクティブã«ç§»å‹•ã—ã¾ã™ã€‚ã“ã“ã§ã¯ã€main 関数ã®æœ€åˆã§ãƒ—ãƒã‚°ãƒ©ãƒ カウンタãŒåœæ¢ã™ã‚‹ã®ã§ã€Play ボタンを押ã—ã¾ã™ã€‚å…¨ã¦ã®ãƒ‡ãƒãƒƒã‚¬ã®ã»ã¨ã‚“ã©ã®æ©Ÿèƒ½ã¯ ARM MCU ã§å‹•ä½œã—ã¾ã™ãŒã€æ£ç¢ºãªè©³ç´°ã«ã¤ã„ã¦ã¯ google ãŒã‚ãªãŸã®ãŠå‹é”ã§ã™ï¼ +虫アイコンをクリックã—ã€ã‚‚ã—å…¨ã¦ã†ã¾ãè¡Œã‘ã° Debug パースペクティブã«ç§»å‹•ã—ã¾ã™ã€‚ã“ã“ã§ã¯ã€main 関数ã®æœ€åˆã§ãƒ—ãƒã‚°ãƒ©ãƒ カウンタãŒåœæ¢ã™ã‚‹ã®ã§ã€Play ボタンを押ã—ã¾ã™ã€‚å…¨ã¦ã®ãƒ‡ãƒãƒƒã‚¬ã®ã»ã¨ã‚“ã©ã®æ©Ÿèƒ½ã¯ ARM MCU ã§å‹•ä½œã—ã¾ã™ãŒã€æ£ç¢ºãªè©³ç´°ã«ã¤ã„ã¦ã¯ google ãŒã‚ãªãŸã®ãŠå‹é”ã§ã™ï¼ ãƒãƒƒãƒ”ーデãƒãƒƒã‚®ãƒ³ã‚°ï¼ diff --git a/docs/ja/getting_started_github.md b/docs/ja/getting_started_github.md index e7af36efa4..0d08ab78b7 100644 --- a/docs/ja/getting_started_github.md +++ b/docs/ja/getting_started_github.md @@ -21,17 +21,23 @@ Github ã¯æ…£ã‚Œã¦ã„ãªã„人ã«ã¯å°‘ã—注æ„ãŒå¿…è¦ã§ã™ - ã“ã®ã‚¬ã‚¤ã  -ã“ã“ã‹ã‚‰ã€`git clone` をコマンドラインã«å…¥åŠ›ã—ã€ãƒªãƒ³ã‚¯ã‚’貼り付ã‘ã¾ã™: +ã“ã“ã‹ã‚‰ã€`git clone --recurse-submodules ` をコマンドラインã«å…¥åŠ›ã—ã€ãƒªãƒ³ã‚¯ã‚’貼り付ã‘ã¾ã™: ``` user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git Cloning into 'qmk_firmware'... -remote: Counting objects: 46625, done. -remote: Compressing objects: 100% (2/2), done. -remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623 -Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. -Resolving deltas: 100% (29362/29362), done. -Checking out files: 100% (2799/2799), done. +remote: Enumerating objects: 9, done. +remote: Counting objects: 100% (9/9), done. +remote: Compressing objects: 100% (5/5), done. +remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 +Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. +Resolving deltas: 100% (119972/119972), done. +... +Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' +Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' +Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' +Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' +Submodule path 'lib/ugfx': checked out '3e97b74e03c93631cdd3ddb2ce43b963fdce19b2' ``` ãƒãƒ¼ã‚«ãƒ«ãƒžã‚·ãƒ³ã« QMK ã®ãƒ•ã‚©ãƒ¼ã‚¯ãŒã§ãã‚‹ã®ã§ã€ã‚ーマップã®è¿½åŠ ã€ã‚³ãƒ³ãƒ‘イルã€ã‚ーボードã¸ã®æ›¸ãè¾¼ã¿ãŒã§ãã¾ã™ã€‚変更ã«æº€è¶³ã—ãŸã‚‰ã€ä»¥ä¸‹ã®ã‚ˆã†ã«ãれらをフォークã¸è¿½åŠ ã€ã‚³ãƒŸãƒƒãƒˆãŠã‚ˆã³ãƒ—ッシュã™ã‚‹ã“ã¨ãŒã§ãã¾ã™: diff --git a/docs/ru-ru/getting_started_github.md b/docs/ru-ru/getting_started_github.md index 8a0fd07a27..3b4940dd15 100644 --- a/docs/ru-ru/getting_started_github.md +++ b/docs/ru-ru/getting_started_github.md @@ -15,17 +15,23 @@ GitHub может показатьÑÑ Ð½ÐµÑколько Ñложным Ð´Ð»Ñ  -Теперь введите `git clone` в командную Ñтроку, а затем вÑтавьте ÑÑылку: +Теперь введите `git clone --recurse-submodules ` в командную Ñтроку, а затем вÑтавьте ÑÑылку: ``` -user@computer:~$ git clone https://github.com/whoeveryouare/qmk_firmware.git +user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git Cloning into 'qmk_firmware'... -remote: Counting objects: 46625, done. -remote: Compressing objects: 100% (2/2), done. -remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623 -Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. -Resolving deltas: 100% (29362/29362), done. -Checking out files: 100% (2799/2799), done. +remote: Enumerating objects: 9, done. +remote: Counting objects: 100% (9/9), done. +remote: Compressing objects: 100% (5/5), done. +remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 +Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. +Resolving deltas: 100% (119972/119972), done. +... +Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' +Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' +Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' +Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' +Submodule path 'lib/ugfx': checked out '3e97b74e03c93631cdd3ddb2ce43b963fdce19b2' ``` Теперь у Ð²Ð°Ñ ÐµÑÑ‚ÑŒ форк QMK на вашем локальном компьютере, и вы можете добавить Ñвою раÑкладку, Ñкомпилировать ее и прошить ей Ñвою клавиатуру. Как только вы будете довольны Ñвоими изменениÑми, еÑÑ‚ÑŒ возможноÑÑ‚ÑŒ добавить, зафикÑировать их и Ñделать коммит в Ñвой форк Ñледующим образом: diff --git a/docs/ru-ru/getting_started_introduction.md b/docs/ru-ru/getting_started_introduction.md index 142fe4254a..ccc4418068 100644 --- a/docs/ru-ru/getting_started_introduction.md +++ b/docs/ru-ru/getting_started_introduction.md @@ -4,7 +4,7 @@ ## Ð‘Ð°Ð·Ð¾Ð²Ð°Ñ Ñтруктура QMK -QMK - Ñто форк [Джуна Вако (Jun Wako)](https://github.com/tmk) проекта [tmk_keyboard](https://github.com/tmk/tmk_keyboard). Оригинальный код TMK Ñ Ð¸Ð·Ð¼ÐµÐ½ÐµÐ½Ð¸Ñми можно найти в папке `tmk`. Ð”Ð¾Ð¿Ð¾Ð»Ð½ÐµÐ½Ð¸Ñ QMK к проекту можно найти в папке `quantum`. Проекты клавиатур можно найти в папках `handwired` и `keyboard`. +QMK - Ñто форк [Джуна Вако (Jun Wako)](https://github.com/tmk) проекта [tmk_keyboard](https://github.com/tmk/tmk_keyboard). Оригинальный код TMK Ñ Ð¸Ð·Ð¼ÐµÐ½ÐµÐ½Ð¸Ñми можно найти в папке `tmk_core`. Ð”Ð¾Ð¿Ð¾Ð»Ð½ÐµÐ½Ð¸Ñ QMK к проекту можно найти в папке `quantum`. Проекты клавиатур можно найти в папках `handwired` и `keyboard`. ### Структура проÑтранÑтва Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ diff --git a/docs/zh-cn/getting_started_github.md b/docs/zh-cn/getting_started_github.md index 0400eea643..2b2f7a75c5 100644 --- a/docs/zh-cn/getting_started_github.md +++ b/docs/zh-cn/getting_started_github.md @@ -16,17 +16,23 @@ Github can be a little tricky to those that aren't familiar with it - this guide  -然åŽï¼Œåœ¨å‘½ä»¤è¡Œè¾“å…¥`git clone `，然åŽç²˜è´´ä½ 的链接: +然åŽï¼Œåœ¨å‘½ä»¤è¡Œè¾“å…¥`git clone --recurse-submodules `，然åŽç²˜è´´ä½ 的链接: ``` -user@computer:~$ git clone https://github.com/whoeveryouare/qmk_firmware.git +user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git Cloning into 'qmk_firmware'... -remote: Counting objects: 46625, done. -remote: Compressing objects: 100% (2/2), done. -remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623 -Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. -Resolving deltas: 100% (29362/29362), done. -Checking out files: 100% (2799/2799), done. +remote: Enumerating objects: 9, done. +remote: Counting objects: 100% (9/9), done. +remote: Compressing objects: 100% (5/5), done. +remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 +Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. +Resolving deltas: 100% (119972/119972), done. +... +Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' +Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' +Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' +Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' +Submodule path 'lib/ugfx': checked out '3e97b74e03c93631cdd3ddb2ce43b963fdce19b2' ``` çŽ°åœ¨ä½ æœ¬åœ°è®¡ç®—æœºæœ‰QMK的分å‰äº†,ä½ å¯ä»¥æ·»åŠ ä½ çš„å¸ƒå±€äº†, ä¸ºä½ çš„é”®ç›˜ç¼–è¯‘å¹¶åˆ·æ–°å›ºä»¶å§ã€‚å¦‚æžœä½ è§‰å¾—ä½ çš„ä¿®æ”¹å¾ˆä¸é”™, ä½ å¯ä»¥æ·»åŠ ,æ交,然åŽæƒ³ä½ 的分å‰æŽ¨å‡ºï¼ˆpullï¼‰ä½ çš„æ”¹å˜ï¼Œåƒè¿™æ ·: diff --git a/docs/zh-cn/getting_started_introduction.md b/docs/zh-cn/getting_started_introduction.md index dcd0b72a56..b977b63390 100644 --- a/docs/zh-cn/getting_started_introduction.md +++ b/docs/zh-cn/getting_started_introduction.md @@ -4,7 +4,7 @@ ## 基本QMK结构 -QMK是[Jun Wako](https://github.com/tmk)çš„[tmk_keyboard](https://github.com/tmk/tmk_keyboard)工程的一个分å‰ã€‚ç»è¿‡æ›´æ”¹çš„TMK原始代ç 放在`tmk` 文件夹ä¸ã€‚ QMKå¢žåŠ çš„æ–°ä¸œè¥¿å¯ä»¥åœ¨ `quantum` 文件夹ä¸æ‰¾åˆ°ã€‚ 键盘项目å¯ä»¥åœ¨ `handwired`（手动飞线） å’Œ `keyboard`（PCB键盘）这两个文件夹找到。 +QMK是[Jun Wako](https://github.com/tmk)çš„[tmk_keyboard](https://github.com/tmk/tmk_keyboard)工程的一个分å‰ã€‚ç»è¿‡æ›´æ”¹çš„TMK原始代ç 放在`tmk_core` 文件夹ä¸ã€‚ QMKå¢žåŠ çš„æ–°ä¸œè¥¿å¯ä»¥åœ¨ `quantum` 文件夹ä¸æ‰¾åˆ°ã€‚ 键盘项目å¯ä»¥åœ¨ `handwired`（手动飞线） å’Œ `keyboard`（PCB键盘）这两个文件夹找到。 ### 用户空间结构 |