auracaster/openocd
3
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README.macOS: Use Markdown syntax

Browse Source 
Refurbish the document and use only Markdown syntax according to the
specification in [1].

[1] https://www.markdownguide.org/

Change-Id: I7ef0d4b7359ba12fd6f2fbf2c4ea1d092dcd71bd
Signed-off-by: Marc Schink <dev@zapb.de>
Reviewed-on: https://review.openocd.org/c/openocd/+/9391
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Tested-by: jenkins
This commit is contained in:
Marc Schink
2024-07-11 16:41:56 +02:00
committed by Antonio Borneo
parent 3ba83c76a2
commit c348b9f2d7
1 changed files with 25 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
README.macOS.md
View File

@@ -1,54 +1,50 @@
Building OpenOCD for macOS # Building OpenOCD for macOS
--------------------------
There are a few prerequisites you will need first: There are a few prerequisites you will need first:
- Xcode (install from the AppStore) - Xcode (install from the AppStore)
- Command Line Tools (install from Xcode -> Preferences -> Downloads) - Command Line Tools (install from Xcode -> Preferences -> Downloads)
- Gentoo Prefix (http://www.gentoo.org/proj/en/gentoo-alt/prefix/bootstrap.xml) - One of the following tools:
or - Gentoo Prefix (<https://wiki.gentoo.org/wiki/Project:Prefix/Bootstrap>)
- Homebrew (http://mxcl.github.io/homebrew/) - Homebrew (<https://brew.sh/>)
or - MacPorts (<https://www.macports.org/install.php>)
- MacPorts (http://www.macports.org/install.php)
If you're building manually you need Texinfo version 5.0 or later. The If you're building manually you need Texinfo version 5.0 or later. The
simplest way to get it is to use Homebrew (brew install texinfo) and simplest way to get it is to use Homebrew (`brew install texinfo`) and
then ``export PATH=/usr/local/opt/texinfo/bin:$PATH``. then `export PATH=/usr/local/opt/texinfo/bin:$PATH`.
With Gentoo Prefix you can build the release version or the latest With Gentoo Prefix you can build the release version or the latest
devel version (-9999) the usual way described in the Gentoo devel version (-9999) the usual way described in the Gentoo
documentation. Alternatively, install the prerequisites and build documentation. Alternatively, install the prerequisites and build
manually from the sources. manually from the sources.
With Homebrew you can either run: With Homebrew you can either run:
brew install [--HEAD] openocd (where optional --HEAD asks brew to brew install [--HEAD] openocd (where optional --HEAD asks brew to
install the current git version) install the current Git version)
or
brew install libtool automake libusb [hidapi] [libftdi] or
(to install the needed dependencies and then proceed with the
brew install libtool automake libusb [hidapi] [libftdi] (to install the needed dependencies and then proceed with the
manual building procedure) manual building procedure)
For building with MacPorts you need to run: For building with MacPorts you need to run:
sudo port install libtool automake autoconf pkgconfig \
libusb [libftdi1]
You should also specify LDFLAGS and CPPFLAGS to allow configure to use sudo port install libtool automake autoconf pkgconfig libusb [libftdi1]
MacPorts' libraries, so run configure like this:
LDFLAGS=-L/opt/local/lib CPPFLAGS=-I/opt/local/include ./configure [options]
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]`
See README.md for the generic building instructions. See [README](README.md) for the generic building instructions.
If you're using a USB adapter and have a driver kext matched to it, 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 you will need to unload it prior to running OpenOCD. E.g. with Apple
driver (OS X 10.9 or later) for FTDI run: driver (OS X 10.9 or later) for FTDI run:
sudo kextunload -b com.apple.driver.AppleUSBFTDI sudo kextunload -b com.apple.driver.AppleUSBFTDI
for FTDI vendor driver use: for FTDI vendor driver use:
sudo kextunload FTDIUSBSerialDriver.kext sudo kextunload FTDIUSBSerialDriver.kext
To learn more on the topic please refer to the official libusb FAQ: To learn more on the topic please refer to the official libusb FAQ: <https://github.com/libusb/libusb/wiki/FAQ>
https://github.com/libusb/libusb/wiki/FAQ