Skip to content

Commit bbc5ec0

Browse files
committed
README: shorten and rephrase build & install section
Signed-off-by: Daniel Maslowski <[email protected]>
1 parent f46798f commit bbc5ec0

File tree

1 file changed

+4
-17
lines changed

1 file changed

+4
-17
lines changed

README.md

+4-17
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,16 @@ requires your IoT system to run a small daemon in order to use it as a resource.
1212

1313
## Build and run
1414

15-
**NOTE**: Go version 1.20 is required as a minimum.
16-
17-
### Git repository
15+
**NOTE**: Go version 1.20 is required as a minimum. For more details, look at
16+
the [Go modules documentation](https://go.dev/ref/mod).
1817

1918
If you have cloned this repository, run `go build ./cmds/sidecore` to build the
2019
command, then `./sidecore -h` for help.
2120

22-
### Quick start
21+
### Quick installation
2322

24-
To try out the command without explicitly cloning, run:
25-
26-
```sh
27-
go run github.com/u-root/sidecore/cmds/sidecore@latest
28-
```
29-
30-
### Installation
31-
32-
To build the binary into your local Go bin directory, run:
23+
To install the binary to your `$GOBIN` (commonly `$HOME/go/bin`) directory, run:
3324

3425
```sh
3526
go install github.com/u-root/sidecore/cmds/sidecore@latest
3627
```
37-
38-
**NOTE**: Ensure to have that bin directory in your `$PATH` to run the resulting
39-
binary conveniently. For more details, look at the `go install` section in the
40-
[Go modules documentation](https://go.dev/ref/mod#go-install).

0 commit comments

Comments
 (0)