Skip to content

Commit dde0d95

Browse files
committed
Add git setup instructions
1 parent 6bdd717 commit dde0d95

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,15 @@ To proceed, the following tools are required:
3939
- ARM GCC, https://launchpad.net/gcc-arm-embedded - for compiling and linking
4040
- GNU make, http://www.gnu.org/software/make/ - for build automation
4141
- ST link, https://github.com/stlink-org/stlink - for flashing
42+
- Git, https://git-scm.com/ - for downloading source code and version control
4243

4344
### Setup instructions for Mac
4445

4546
Start a terminal, and execute:
4647

4748
```sh
4849
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
49-
$ brew install gcc-arm-embedded make stlink
50+
$ brew install gcc-arm-embedded make stlink git
5051
```
5152

5253
### Setup instructions for Linux (Ubuntu)
@@ -55,7 +56,7 @@ Start a terminal, and execute:
5556

5657
```sh
5758
$ sudo apt -y update
58-
$ sudo apt -y install gcc-arm-none-eabi make stlink-tools
59+
$ sudo apt -y install gcc-arm-none-eabi make stlink-tools git
5960
```
6061

6162
### Setup instructions for Windows
@@ -65,16 +66,19 @@ $ sudo apt -y install gcc-arm-none-eabi make stlink-tools
6566
- Download [stlink-1.7.0-x86_64-w64-mingw32.zip](https://github.com/stlink-org/stlink/releases/download/v1.7.0/stlink-1.7.0-x86_64-w64-mingw32.zip) and unpack `bin/st-flash.exe` into `c:\tools`
6667
- Download [make-4.4-without-guile-w32-bin.zip](https://sourceforge.net/projects/ezwinports/files/make-4.4-without-guile-w32-bin.zip/download) and unpack `bin/make.exe` into `c:\tools`
6768
- Add `c:\tools` to the `Path` environment variable
68-
- Verify installation:
69-
- Download and unzip [this repository](https://github.com/cpq/bare-metal-programming-guide/archive/refs/heads/main.zip) into `c:\`
70-
- Start command prompt, and execute the following:
71-
<pre style="color: silver;">
72-
C:\Users\YOURNAME> <b style="color: black;">cd \</b>
73-
C:\> <b style="color: black;">cd bare-metal-programming-guide-main\step-0-minimal</b>
74-
C:\bare-metal-programming-guide-main\step-0-minimal> <b style="color: black;">make</b>
75-
arm-none-eabi-gcc main.c -W -Wall -Wextra -Werror ...
76-
</pre>
69+
- Enable "Developer Mode" in Windows 10/11, for symbolic link support.
70+
- Install Git from https://git-scm.com/download/win. Check "Enable symlink" during installation
7771

72+
### Verify installed tools
73+
74+
Now, when all required tools are installed, start terminal/command prompt, and
75+
enter the following commands to download this repository and build an example:
76+
77+
```sh
78+
git clone https://github.com/cpq/bare-metal-programming-guide
79+
cd bare-metal-programming-guide/step-0-minimal
80+
make
81+
```
7882

7983
## Introduction
8084

0 commit comments

Comments
 (0)