Skip to content

Commit 834926c

Browse files
smithp35mplatings
andcommitted
Update samples README with macOS information (#226)
* Update samples README with macOS information The LLVM Embedded Toolchain for Arm has a macOS release. Update the samples README to claim support and to point the reader to the instructions for installing QEMU. macOS requires the developer tools to be installed to run the samples, which also installs LLDB. The existing instructions for Linux work for macOS. * Update samples/README.md Co-authored-by: Michael Platings <[email protected]> * Update samples to note that we support four environments. --------- Co-authored-by: Michael Platings <[email protected]>
1 parent 1b21e74 commit 834926c

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

samples/README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,17 @@ Embedded Toolchain for Arm.
1111

1212
## Supported environments
1313

14-
The build scripts support three different environments:
14+
The build scripts support four different environments:
1515
* Linux
16+
* macOS
1617
* Windows
1718
* Windows + [MSYS2](https://www.msys2.org/)
1819

1920
## Prerequisites
2021

2122
In order to compile the samples you will need the following tools:
2223
* LLVM Embedded Toolchain for Arm
23-
* GNU Make (Linux and MSYS2)
24+
* GNU Make (Linux, macOS and MSYS2)
2425

2526
To run the samples you will need a QEMU emulator to be installed on your
2627
machine. The samples rely on
@@ -30,13 +31,17 @@ the QEMU Arm System emulator. On Ubuntu Linux it can be installed as follows:
3031
# apt-get install qemu-system-arm
3132
```
3233

34+
On macOS the QEMU Arm System emulator can be installed via HomeBrew or
35+
Mac Ports. Instructions can be found in
36+
https://www.qemu.org/download/#macos
37+
3338
The Windows installer can be downloaded from
3439
https://www.qemu.org/download/#windows.
3540

36-
To debug the samples you will need to install a debugger
37-
that supports Arm targets, for example,
41+
To debug the samples you will need to install a debugger
42+
that supports Arm targets, for example,
3843
[LLDB](https://lldb.llvm.org/) version matching LLVM Embedded Toolchain for Arm.
39-
Debugging is only supported on Linux.
44+
Debugging is only supported on Linux and macOS.
4045

4146
## Specifying the location of the installed toolchain
4247

@@ -52,7 +57,7 @@ to the ``bin`` directory of the toolchain.
5257

5358
## Compiling, running and debugging the samples
5459

55-
### Linux and MSYS2
60+
### Linux, macOS and MSYS2
5661

5762
Change to the directory of a specific sample (e.g. ``src/baremetal-uart``) and
5863
use the following commands to build, run or debug the sample:

0 commit comments

Comments
 (0)