Skip to content

Commit bdbdf2e

Browse files
committed
Update documentation to reflect "go install" approach
1 parent 6a5e316 commit bdbdf2e

1 file changed

Lines changed: 30 additions & 25 deletions

File tree

README.md

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -136,42 +136,30 @@ For more details about invocation options, please consult the [manpage](./MANPAG
136136

137137
## Installation
138138

139-
If not available as a package, `autoreverse` should compile and run on most Unix-like
140-
systems which support the [go](https://go.dev) compiler. It also cross-compiles and run on
141-
Windows.
139+
Regardless of how you compile or install `autoreverse` you'll need a recent version of
140+
[go](https://golang.org). 1.17 or later is recommended.
142141

142+
### Installation the 'go' way
143143

144-
### Prerequisites
145-
146-
To compile `autoreverse` you need a recent version of [go](https://golang.org). 1.17 or
147-
later is recommended.
148-
149-
### Target Systems and cross-compiling
150-
151-
`autoreverse` has been tested on various CPU architectures with FreeBSD, Linux and
152-
macOS. The [Makefile](./Makefile) in the installation directory builds and installs
153-
`autoreverse` into `/usr/local/sbin`. Modify as necessary.
144+
```sh
145+
go install https://github.com/markdingo/autoreverse
146+
```
154147

155-
`autoreverse` *may* compile and run on Windows but you can also cross-compile to Windows
156-
on a Unix-like system. To assist in this the Makefile contains the `windowsamd64` and
157-
`windows386` targets.
148+
should result in an `autoreverse` executable in `$GOPATH/bin` or `$HOME/go/bin`.
158149

159-
Perhaps of most interest to residential deployments is the possibility of installing
160-
`autoreverse` on your gateway router. To that end, the Makefile has targets for a
161-
few *prosumer* routers such as Ubiquiti Edge Routers and Mikrotik Router Boards. It should
162-
be possible to target other platforms too! This project is very interested to hear of
163-
attempts to install `autoreverse` on gateway routers so please provide feedback of
164-
successes *and* failures.
150+
While the simplicity of installing the 'go' way has its merits, it
151+
doesn't install in traditional Unix locations, nor does it install the
152+
manpage. To do that you'll need to compile and install the 'Unix' way
165153

166-
### Compilation From Sources
154+
### Compile and install the 'Unix' way
167155

168156
To fetch, compile and install `autoreverse`, run the following commands to install
169-
`autoreverse` into into `/usr/local/sbin`
157+
`autoreverse` into `/usr/local/sbin`
170158

171159
```sh
172160
git clone https://github.com/markdingo/autoreverse.git
173161
cd autoreverse
174-
make clean all
162+
make all
175163
sudo make install
176164
```
177165

@@ -187,6 +175,23 @@ man autoreverse
187175
All being well, you should see `autoreverse` print version details followed by the start
188176
of the manpage.
189177

178+
### Target Systems and cross-compiling
179+
180+
`autoreverse` has been tested on various CPU architectures with FreeBSD, Linux and
181+
macOS. The [Makefile](./Makefile) in the installation directory builds and installs
182+
`autoreverse` into `/usr/local/sbin`. Modify as necessary.
183+
184+
`autoreverse` *may* compile and run on Windows but you can also cross-compile to Windows
185+
on a Unix-like system. To assist in this the Makefile contains the `windowsamd64` and
186+
`windows386` targets.
187+
188+
Perhaps of most interest to residential deployments is the possibility of installing
189+
`autoreverse` on your gateway router. To that end, the Makefile has targets for a
190+
few *prosumer* routers such as Ubiquiti Edge Routers and Mikrotik Router Boards. It should
191+
be possible to target other platforms too! This project is very interested to hear of
192+
attempts to install `autoreverse` on gateway routers so please provide feedback of
193+
successes *and* failures.
194+
190195
### Community
191196

192197
If you have any problems using `autoreverse` or suggestions on how it can do a better job,

0 commit comments

Comments
 (0)