Skip to content

Commit 8bc12d9

Browse files
zapb-0borneoa
authored andcommitted
README.macOS: Align structure and fix linter errors
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>
1 parent 91799d0 commit 8bc12d9

File tree

1 file changed

+33
-11
lines changed

1 file changed

+33
-11
lines changed

README.macOS.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Building OpenOCD for macOS
1+
# OpenOCD for macOS
2+
3+
This README contains instructions that are specific to macOS.
4+
5+
## Building
26

37
There are a few prerequisites you will need first:
48

@@ -20,31 +24,49 @@ manually from the sources.
2024

2125
With Homebrew you can either run:
2226

23-
brew install [--HEAD] openocd (where optional --HEAD asks brew to
24-
install the current Git version)
27+
```sh
28+
brew install [--HEAD] open-ocd
29+
```
30+
31+
Where ``--HEAD`` asks ``brew`` to install the current Git version instead of the
32+
lastest release.
2533

26-
or
34+
You can also run:
2735

28-
brew install libtool automake libusb [hidapi] [libftdi] (to install the needed dependencies and then proceed with the
29-
manual building procedure)
36+
```sh
37+
brew install libtool automake libusb [hidapi] [libftdi]
38+
```
39+
40+
to install the needed dependencies and then proceed with the manual building
41+
procedure.
3042

3143
For building with MacPorts you need to run:
3244

33-
sudo port install libtool automake autoconf pkgconfig libusb [libftdi1]
45+
```sh
46+
sudo port install libtool automake autoconf pkgconfig libusb [libftdi1]
47+
```
3448

3549
You should also specify LDFLAGS and CPPFLAGS to allow `configure` to use
36-
MacPorts' libraries, so run configure like this: `LDFLAGS=-L/opt/local/lib CPPFLAGS=-I/opt/local/include ./configure [options]`
50+
MacPorts' libraries, so run configure like this:
51+
52+
```sh
53+
LDFLAGS=-L/opt/local/lib CPPFLAGS=-I/opt/local/include ./configure [options]
54+
```
3755

3856
See [README](README.md) for the generic building instructions.
3957

4058
If you're using a USB adapter and have a driver kext matched to it,
4159
you will need to unload it prior to running OpenOCD. E.g. with Apple
4260
driver (OS X 10.9 or later) for FTDI run:
4361

44-
sudo kextunload -b com.apple.driver.AppleUSBFTDI
62+
```sh
63+
sudo kextunload -b com.apple.driver.AppleUSBFTDI
64+
```
4565

4666
for FTDI vendor driver use:
4767

48-
sudo kextunload FTDIUSBSerialDriver.kext
68+
```sh
69+
sudo kextunload FTDIUSBSerialDriver.kext
70+
```
4971

50-
To learn more on the topic please refer to the official libusb FAQ: <https://github.com/libusb/libusb/wiki/FAQ>
72+
To learn more on the topic please refer to the official libusb FAQ: <https://github.com/libusb/libusb/wiki/FAQ>

0 commit comments

Comments
 (0)