Skip to content

Commit a91c71a

Browse files
committed
README: use backticks for code and commands (only)
This is a bit subjective and doesn't seem to have universal best practices, but since the syntax is called "Code spans" according to the CommonMark specification, it makes sense to only use them for (partial) code or commands.
1 parent 77f6f45 commit a91c71a

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
The comments and instructions below are for the new IP stack in Zephyr.
66

77
In a Zephyr default setup, the network tools are pre-installed under the
8-
`tools` directory.
8+
tools directory.
99

1010
Here are instructions for how to communicate between Zephyr running
1111
inside QEMU, and a host device that is running Linux.
1212

1313
For setting up routing and NAT rules to allow access to external networks, please see
1414
[README NAT.md](README%20NAT.md)
1515

16-
You need to run *socat* and *tunslip* to create a minimally working
16+
You need to run `socat` and `tunslip` to create a minimally working
1717
network setup.
1818

1919
There are convenience scripts (_loop-socat.sh_ and _loop-slip-tap.sh_) for
@@ -101,8 +101,8 @@ $ net-setup.sh --config my-own-config.conf --iface foobar
101101

102102
It is also possible to let the script return and then stop the network
103103
interface later. This can be done by first creating the interface with the
104-
"start" or "up" command, and then later remove the interface with the
105-
"stop" or "down" command.
104+
`start` or `up` command, and then later remove the interface with the
105+
`stop` or `down` command.
106106
```
107107
$ net-setup.sh start
108108
do your things here
@@ -115,15 +115,14 @@ $ net-setup.sh --config my-own-config.conf down
115115
```
116116

117117
Any extra parameters that the script does not know, are passed directly
118-
to the "ip" command.
118+
to the `ip` command.
119119
```
120120
$ net-setup.sh --config my-own-config.conf --iface foo user bar
121121
```
122122

123123
## Using encrypted SSL link with echo-* programs
124124

125-
Install stunnel
126-
125+
Install `stunnel`.
127126
Fedora:
128127
```
129128
$ dnf install stunnel
@@ -244,7 +243,7 @@ CONFIG_MBEDTLS_HEAP_SIZE=30000
244243
## PPP Connectivity
245244

246245
You can test the PPP connectivity running Zephyr in QEMU using a pppd that is
247-
running on the Linux host. You need to run *socat* and *pppd* to create
246+
running on the Linux host. You need to run `socat` and `pppd` to create
248247
a minimally working network setup.
249248

250249
There are convenience scripts (_loop-ppp-dev.sh_ and _loop-pppd.sh_) for

0 commit comments

Comments
 (0)