Skip to content

Commit b16bec3

Browse files
committed
Updated Using git repository (markdown)
1 parent c3dc928 commit b16bec3

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

_dev/Using-git-repository.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,35 @@
11
To use the [Arduino_Core_STM32](https://github.com/stm32duino/Arduino_Core_STM32) git repository instead of the package version, follow those steps:
22

33
## 1. Install the STM32 Cores package
4-
See the [[Getting Started|Getting-Started]] page.
5-
This will install the required dependencies for the current released version.
6-
To get started with development on main you must install the correct versions of the required dependencies (see: [platform.txt](https://github.com/stm32duino/Arduino_Core_STM32/blob/main/platform.txt)):
4+
5+
To get started with development on `main` branch, correct versions of the required dependencies have to be installed (see: [platform.txt](https://github.com/stm32duino/Arduino_Core_STM32/blob/main/platform.txt)):
76
* [CMSIS](https://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php): ARM® Cortex® Microcontroller Software Interface Standard
8-
* [arm-none-eabi-gcc](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm): GNU ARM Embedded Toolchain
7+
* [GNU Arm Embedded Toolchain](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm): Arm Embedded GCC compiler, libraries and other GNU tools necessary for bare-metal software development on devices based on the Arm Cortex-M. Packages are provided thanks [The xPack GNU Arm Embedded GCC](https://xpack.github.io/arm-none-eabi-gcc/): https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack
98
* [STM32Tools](https://github.com/stm32duino/Arduino_Tools): upload tools for STM32 based boards and some other useful scripts
109

10+
Using the git repository requires sometimes to update tools dependencies.
11+
12+
Example when the arm-none-abi-gcc toolchain or the CMSIS version are updated. In that case, all dependencies are available in the [package_stmicroelectronics_index.json](https://github.com/stm32duino/BoardManagerFiles/blob/dev/package_stmicroelectronics_index.json) of the BoardManagerFiles `dev` branch.
13+
14+
See the [[Getting Started|Getting-Started]] page to see how to install the core and its tools dependencies but use this link in the "Additional Boards Managers URLs" field:
15+
16+
https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/dev/package_stmicroelectronics_index.json
17+
18+
Then install the latest version displayed by the board manager, if a version is suffixed by `-dev` it means one or more dependencies have been updated else no change done since the last release.
19+
20+
This will install the required dependencies for the main branch.
21+
1122
## 2. Delete the stm32 core extracted package
1223
Go to the installed package directory: [[Where-are-sources]]
1324

14-
Delete the version directory: `<x.y.z>`
25+
Delete the version directory: `<x.y.z>` or `<x.y.z-dev>`
26+
27+
Note: There must be no other directories along side the `<x.y.z>` or `<x.y.z-dev>` directory, so don't just rename the old one - it will cause problems later. If you want to keep it, move it somewhere else entirely.
1528

16-
Note: There must be no other directories along side the `<x.y.z>` directory, so don't just rename the old one - it will cause problems later. If you want to keep it, move it somewhere else entirely.
29+
## 3. Cloning the git repository to replace the stm32 core version package (1st method)
1730

18-
## 3. Hereafter, 2 methods to use git repository
1931
Directory of step 2 is now deleted.<br>
2032

21-
### 3.1. Cloning the git repository to replace the stm32 core version package (1st method)
2233
In the "_**\<local Arduino directory\>/packages/STMicroelectronics/hardware/stm32/**_" do the clone:<br>
2334

2435
`git clone https://github.com/stm32duino/Arduino_Core_STM32.git <version>`
@@ -29,18 +40,8 @@ So, do:<br>
2940

3041
`git clone https://github.com/stm32duino/Arduino_Core_STM32.git 2.0.0`
3142

32-
[[/img/Tips-icon.png|alt="Tips"]] _It is possible to clone it elsewhere and create a symlink named \<version>_<br>
43+
[[/img/Tips-icon.png|alt="Tips"]] _On Linux, It is possible to clone it elsewhere and create a symlink named \<version>_<br>
3344

3445
[[/img/Important-icon.png|alt="Important"]] _Uninstalling from the boards managers will remove the git repository!_
3546

36-
### 3.2. Adding repositories in _Arduino/hardware_ directory (2nd method)
37-
Go to the "_**\<Arduino install directory\>/hardware/**_" and create a directory named: _**STM32**_<br>
38-
[[/img/Warning-icon.png|alt="Warning"]] The name of the new directory to clone into must be _**STM32**_!
39-
40-
Go to this new directory then do the clone:<br>
41-
42-
`git clone https://github.com/stm32duino/Arduino_Core_STM32.git stm32`
43-
44-
[[/img/Warning-icon.png|alt="Warning"]] The name of the new directory to clone into must be _**stm32**_!
45-
4647
[[/img/Note-icon.png|alt="Note"]] If you do not have deleted the stm32 core extracted package (step [2.](https://github.com/stm32duino/wiki/wiki/Using-git-repository/_edit#2-delete-the-stm32-core-extracted-package)), in "**Tools > Board**" menu, you will have twice the "**STM32 board**" menu.<br>

0 commit comments

Comments
 (0)