File tree 1 file changed +23
-4
lines changed
1 file changed +23
-4
lines changed Original file line number Diff line number Diff line change @@ -10,12 +10,31 @@ Using flattened Docker images from <https://github.com/u-root/sidecore-images>,
10
10
Building on top of [ ` cpu ` ] ( https://github.com/u-root/cpu ) , ** sidecore** merely
11
11
requires your IoT system to run a small daemon in order to use it as a resource.
12
12
13
- ## Building
13
+ ## Build and run
14
14
15
15
** NOTE** : Go version 1.20 is required as a minimum.
16
16
17
- Run ` go build ./cmds/sidecore ` to build the command.
17
+ ### Git repository
18
18
19
- ## Usage
19
+ If you have cloned this repository, run ` go build ./cmds/sidecore ` to build the
20
+ command, then ` ./sidecore -h ` for help.
20
21
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 ) .
You can’t perform that action at this time.
0 commit comments