auracaster/sw_openocd
3
0
Fork 0
forked from auracaster/openocd
Code Pull Requests Activity

README.macOS: Align structure and fix linter errors

Browse Source 
Refactor the document structure to align with README.Windows and fix
two line-length issues so that the file is free of Markdown linter [1]
errors.

[1] https://github.com/jackdewinter/pymarkdown

Change-Id: Iab5ca09aeed2225e43934c8c2bd952a3a4b32cd0
Signed-off-by: Marc Schink <dev@zapb.de>
Reviewed-on: https://review.openocd.org/c/openocd/+/9403
Tested-by: jenkins
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
This commit is contained in:
Marc Schink
2026-01-26 06:58:28 +01:00
committed by Antonio Borneo
parent 91799d0579
commit 8bc12d98e7
1 changed files with 33 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.macOS.md
View File

@@ -1,4 +1,8 @@
# Building OpenOCD for macOS
# OpenOCD for macOS
This README contains instructions that are specific to macOS.
## Building
There are a few prerequisites you will need first:
@@ -20,20 +24,34 @@ manually from the sources.
With Homebrew you can either run:
brew install [--HEAD] openocd (where optional --HEAD asks brew to
install the current Git version)
```sh
brew install [--HEAD] open-ocd
```
or
Where ``--HEAD`` asks ``brew`` to install the current Git version instead of the
lastest release.
brew install libtool automake libusb [hidapi] [libftdi] (to install the needed dependencies and then proceed with the
manual building procedure)
You can also run:
```sh
brew install libtool automake libusb [hidapi] [libftdi]
```
to install the needed dependencies and then proceed with the manual building
procedure.
For building with MacPorts you need to run:
```sh
sudo port install libtool automake autoconf pkgconfig libusb [libftdi1]
```
You should also specify LDFLAGS and CPPFLAGS to allow `configure` to use
MacPorts' libraries, so run configure like this: `LDFLAGS=-L/opt/local/lib CPPFLAGS=-I/opt/local/include ./configure [options]`
MacPorts' libraries, so run configure like this:
```sh
LDFLAGS=-L/opt/local/lib CPPFLAGS=-I/opt/local/include ./configure [options]
```
See [README](README.md) for the generic building instructions.
@@ -41,10 +59,14 @@ If you're using a USB adapter and have a driver kext matched to it,
you will need to unload it prior to running OpenOCD. E.g. with Apple
driver (OS X 10.9 or later) for FTDI run:
```sh
sudo kextunload -b com.apple.driver.AppleUSBFTDI
```
for FTDI vendor driver use:
```sh
sudo kextunload FTDIUSBSerialDriver.kext
```
To learn more on the topic please refer to the official libusb FAQ: <https://github.com/libusb/libusb/wiki/FAQ>