Skip to content

Commit f46798f

Browse files
committed
README: add quick start and installation instructions
Signed-off-by: Daniel Maslowski <[email protected]>
1 parent bb234a1 commit f46798f

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.md

+23-4
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,31 @@ Using flattened Docker images from <https://github.com/u-root/sidecore-images>,
1010
Building on top of [`cpu`](https://github.com/u-root/cpu), **sidecore** merely
1111
requires your IoT system to run a small daemon in order to use it as a resource.
1212

13-
## Building
13+
## Build and run
1414

1515
**NOTE**: Go version 1.20 is required as a minimum.
1616

17-
Run `go build ./cmds/sidecore` to build the command.
17+
### Git repository
1818

19-
## Usage
19+
If you have cloned this repository, run `go build ./cmds/sidecore` to build the
20+
command, then `./sidecore -h` for help.
2021

21-
After building the command, run `./sidecore -h` for help.
22+
### Quick start
23+
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:
33+
34+
```sh
35+
go install github.com/u-root/sidecore/cmds/sidecore@latest
36+
```
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)