Skip to content

Commit 20bd8e8

Browse files
authored
Add code color highlighting to the README
And fix some typos.
1 parent 0aa443c commit 20bd8e8

File tree

1 file changed

+44
-41
lines changed

1 file changed

+44
-41
lines changed

README.md

Lines changed: 44 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -21,38 +21,38 @@ status](https://repology.org/badge/vertical-allrepos/eternalterminal.svg)](https
2121

2222
The easiest way to install is using Homebrew:
2323

24-
```
24+
```bash
2525
brew install MisterTea/et/et
2626
```
2727

2828
Then if you want a daemon to launch `etserver` on every boot:
2929

3030
On m1 (Apple Silicon) Macs:
3131

32-
```
32+
```bash
3333
sudo sed 's:/usr/local/bin/etserver:/opt/homebrew/bin/etserver:g' ../init/launchd/homebrew.mxcl.et.plist | sudo tee /Library/LaunchDaemons/homebrew.mxcl.et.plist
3434
sudo launchctl load -w /Library/LaunchDaemons/homebrew.mxcl.et.plist
3535
```
3636

3737
On x86 Macs:
3838

39-
```
39+
```bash
4040
sudo cp ../init/launchd/homebrew.mxcl.et.plist /Library/LaunchDaemons/homebrew.mxcl.et.plist
4141
sudo launchctl load -w /Library/LaunchDaemons/homebrew.mxcl.et.plist
4242
```
4343

4444

4545
Alternatively, a package is available in MacPorts:
4646

47-
```
47+
```bash
4848
sudo port install et
4949
```
5050

5151
### Ubuntu
5252

5353
For Ubuntu, use our PPA:
5454

55-
```
55+
```bash
5656
sudo add-apt-repository ppa:jgmath2000/et
5757
sudo apt-get update
5858
sudo apt-get install et
@@ -63,9 +63,9 @@ Or see "Debian/Ubuntu" below to install and build from source (e.g., for ARM).
6363

6464
### Debian
6565

66-
For debian, use our deb repo. For buster:
66+
For Debian, use our deb repo. For buster:
6767

68-
```
68+
```bash
6969
echo "deb https://github.com/MisterTea/debian-et/raw/master/debian-source/ buster main" | sudo tee -a /etc/apt/sources.list.d/et.list
7070
curl -sSL https://github.com/MisterTea/debian-et/raw/master/et.gpg | sudo tee /etc/apt/trusted.gpg.d/et.gpg >/dev/null
7171
sudo apt update
@@ -78,27 +78,27 @@ Up to the present day the only way to install is to [build from source](#centos-
7878

7979
### CentOS 8
8080

81-
```
81+
```bash
8282
sudo dnf install epel-release
8383
sudo dnf install et
8484
```
8585

8686
### FreeBSD
8787
On FreeBSD, use:
8888

89-
```
89+
```bash
9090
pkg install eternalterminal
9191
```
9292

9393
### Fedora (version 29 and later):
9494

95-
```
95+
```bash
9696
sudo dnf install et
9797
```
9898

9999
### openSUSE
100100

101-
```
101+
```bash
102102
zypper ar -f obs://network
103103
zypper ref
104104
zypper in EternalTerminal
@@ -110,21 +110,21 @@ Install dependencies:
110110

111111
* Fedora (tested on 25):
112112

113-
```
113+
```bash
114114
sudo dnf install boost-devel libsodium-devel protobuf-devel \
115115
protobuf-compiler cmake gflags-devel libcurl-devel
116116
```
117117

118118
* Gentoo:
119119

120-
```
120+
```bash
121121
sudo emerge dev-libs/boost dev-libs/libsodium \
122122
dev-libs/protobuf dev-util/cmake dev-cpp/gflags
123123
```
124124

125125
Download and install from source:
126126

127-
```
127+
```bash
128128
git clone --recurse-submodules https://github.com/MisterTea/EternalTerminal.git
129129
cd EternalTerminal
130130
mkdir build
@@ -160,26 +160,26 @@ ET uses ssh for handshaking and encryption, so you must be able to ssh into the
160160

161161
ET uses TCP, so you need an open port on your server. By default, it uses 2022.
162162

163-
Once you have an open port, the syntax is similar to ssh. Username is default to the current username starting the et process, use `-u` or `user@` to specify a different if necessary.
164-
```
163+
Once you have an open port, the syntax is similar to ssh. Username is default to the current username starting the et process, use `-u` or `user@` to specify a different one if necessary.
164+
```bash
165165
et hostname (etserver running on default port 2022, username is the same as current)
166166
et user@hostname:8000 (etserver running on port 8000, different user)
167167
```
168168
You can specify a jumphost and the port et is running on jumphost using `--jumphost` and `--jport`. If no `--jport` is given, et will try to connect to default port 2022.
169-
```
170-
et hostname -jumphost jump_hostname (etserver running on port 2022 on both hostname and jumphost)
169+
```bash
170+
et hostname --jumphost jump_hostname (etserver running on port 2022 on both hostname and jumphost)
171171
et hostname:8888 --jumphost jump_hostname --jport 9999
172172
```
173-
Additional arguments that et accept are port forwarding pairs with option `-t "18000:8000, 18001-18003:8001-8003"`, a command to run immediately after the connection is setup through `-c`.
173+
Additional arguments that et accepts are port forwarding pairs with option `-t "18000:8000, 18001-18003:8001-8003"`, a command to run immediately after the connection is set up through `-c`.
174174

175-
Starting from the latest release, et supports parsing both user-specific and system-wide ssh config file.
176-
The config file is required when your sshd on server/jumphost is listening on a port which is not 22.
177-
Here is an example ssh config file showing how to setup when
175+
Starting from the latest release, et supports parsing both user-specific and system-wide ssh config files.
176+
The config file is required when your sshd on server/jumphost is listening on a port that is not 22.
177+
Here is an example SSH config file showing how to set up when
178178
- there is a jumphost in the middle
179-
- sshd is listening on a port which is not 22
180-
- connecting to a different username other than current one.
179+
- sshd is listening on a port that is not 22
180+
- connecting to a different username other than the current one.
181181

182-
```
182+
```ssh-config
183183
Host dev
184184
HostName 192.168.1.1
185185
User fred
@@ -189,7 +189,7 @@ Host dev
189189

190190
With the ssh config file set as above, you can simply call et with
191191

192-
```
192+
```bash
193193
et dev (etserver running on port 2022 on both hostname and jumphost)
194194
et dev:8000 -jport 9000 (etserver running on port 9000 on jumphost)
195195
```
@@ -200,7 +200,7 @@ et dev:8000 -jport 9000 (etserver running on port 9000 on jumphost)
200200

201201
To build Eternal Terminal on Mac, the easiest way is to grab dependencies with Homebrew:
202202

203-
```
203+
```bash
204204
brew install --only-dependencies MisterTea/et/et
205205
git clone --recurse-submodules https://github.com/MisterTea/EternalTerminal.git
206206
cd EternalTerminal
@@ -215,7 +215,7 @@ make && sudo make install
215215
To run an `et` server for testing, run `./etserver`. To run an `et`
216216
server daemon persistently across reboots:
217217

218-
```
218+
```bash
219219
sudo cp ../init/launchd/homebrew.mxcl.et.plist /Library/LaunchDaemons
220220
sudo launchctl load -w /Library/LaunchDaemons/homebrew.mxcl.et.plist
221221
```
@@ -226,15 +226,15 @@ Grab the deps and then follow this process.
226226

227227
Debian/Ubuntu Dependencies:
228228

229-
```
229+
```bash
230230
sudo apt install libboost-dev libsodium-dev \
231231
libprotobuf-dev protobuf-compiler libgflags-dev libutempter-dev libcurl4-openssl-dev \
232232
build-essential ninja-build cmake git zip
233233
```
234234

235235
Fetch source, build and install:
236236

237-
```
237+
```bash
238238
git clone --recurse-submodules https://github.com/MisterTea/EternalTerminal.git
239239
cd EternalTerminal
240240
mkdir build
@@ -253,21 +253,21 @@ Once built, the binary only requires `libgflags-dev` and `libprotobuf-dev`.
253253
### CentOS 7
254254

255255
Install dependencies:
256-
```
256+
```bash
257257
sudo yum install epel-release
258258
sudo yum install cmake3 boost-devel libsodium-devel protobuf-devel \
259259
protobuf-compiler gflags-devel protobuf-lite-devel libcurl-devel \
260260
perl-IPC-Cmd perl-Data-Dumper libunwind-devel libutempter-devel
261261
```
262262

263263
Install scl dependencies
264-
```
264+
```bash
265265
sudo yum install centos-release-scl
266266
sudo yum install devtoolset-11 devtoolset-11-libatomic-devel rh-git227
267267
```
268268

269269
Download and install from source ([see #238 for details](https://github.com/MisterTea/EternalTerminal/issues/238)):
270-
```
270+
```bash
271271
git clone --recurse-submodules https://github.com/MisterTea/EternalTerminal.git
272272
cd EternalTerminal
273273
mkdir build
@@ -280,27 +280,31 @@ sudo cp ../etc/et.cfg /etc/
280280

281281
Find the actual location of et:
282282

283-
which etserver
283+
```bash
284+
which etserver
285+
```
284286

285287
Correct the service file (see [#180](https://github.com/MisterTea/EternalTerminal/issues/180) for details).
286288

287-
```
289+
```bash
288290
sudo sed -ie "s|ExecStart=[^[:space:]]*[[:space:]]|ExecStart=$(which etserver) |" /etc/systemd/system/et.service
289291
```
290292

291-
Alternativelly, open the file /etc/systemd/system/et.service in an editor and correct the `ExectStart=...` line to point to the correct path of the `etserver` binary.
293+
Alternatively, open the file /etc/systemd/system/et.service in an editor and correct the `ExectStart=...` line to point to the correct path of the `etserver` binary.
292294

293-
ExecStart=/usr/local/bin/etserver --cfgfile=/etc/et.cfg
295+
```
296+
ExecStart=/usr/local/bin/etserver --cfgfile=/etc/et.cfg
297+
```
294298

295299
Reload systemd configs:
296300

297-
```
301+
```bash
298302
sudo systemctl daemon-reload
299303
```
300304

301305
Start the et service:
302306

303-
```
307+
```bash
304308
sudo systemctl enable --now et.service
305309
```
306310

@@ -310,11 +314,10 @@ Builder Dockerfiles are located at [deployment/](deployment/). Supported OSes: C
310314

311315
## Reporting issues
312316

313-
If you have any problems with installation or usage, please [file an issue on github](https://github.com/MisterTea/EternalTerminal/issues).
317+
If you have any problems with installation or usage, please [file an issue on GitHub](https://github.com/MisterTea/EternalTerminal/issues).
314318

315319
## Developers
316320

317321
- Jason Gauci: https://github.com/MisterTea
318322
- Ailing Zhang: https://github.com/ailzhang
319323
- James Short: https://github.com/jshort
320-

0 commit comments

Comments
 (0)