Skip to content

Commit 161d0a2

Browse files
Suggest to build binaries inside dist folder
Signed-off-by: federicobozzini <federico.bozzini@gmail.com>
1 parent b033cfd commit 161d0a2

1 file changed

Lines changed: 13 additions & 15 deletions

File tree

docs/DEVELOPMENT.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,9 @@ The project consists of two main components:
2020
### Build all components
2121

2222
```bash
23-
go build ./cmd/containerd-shim-remoteproc-v1
24-
```
25-
26-
```bash
27-
go build ./cmd/remoteproc-runtime
23+
mkdir -p dist
24+
go build -o dist/containerd-shim-remoteproc-v1 ./cmd/containerd-shim-remoteproc-v1
25+
go build -o dist/remoteproc-runtime ./cmd/remoteproc-runtime
2826
```
2927

3028
⚠️ This runtime specifically targets Linux; building on other platforms requires setting `GOOS=linux`. If cross-compiling, specify the target architecture with `GOARCH=arm64`.
@@ -81,12 +79,11 @@ Useful for development without access to hardware with Remoteproc support.
8179
1. **Build and install the shim and runtime with custom root**
8280

8381
```bash
84-
go build ./cmd/containerd-shim-remoteproc-v1
85-
```
82+
mkdir -p dist
83+
go build -o dist/containerd-shim-remoteproc-v1 ./cmd/containerd-shim-remoteproc-v1
8684

87-
```bash
8885
go build -ldflags "-X github.com/arm/remoteproc-runtime/internal/rootpath.prefix=/tmp/test-root" \
89-
./cmd/remoteproc-runtime
86+
-o dist/remoteproc-runtime ./cmd/remoteproc-runtime
9087
```
9188

9289
See "Install the shim and runtime" in [Usage Guide](USAGE.md).
@@ -123,8 +120,9 @@ Useful for development without access to hardware with Remoteproc support.
123120
1. **Build the runtime with custom root**
124121

125122
```bash
123+
mkdir -p dist
126124
go build -ldflags "-X github.com/arm/remoteproc-runtime/internal/rootpath.prefix=/tmp/test-root" \
127-
./cmd/remoteproc-runtime
125+
-o dist/remoteproc-runtime ./cmd/remoteproc-runtime
128126
```
129127

130128
1. **Setup Remoteproc Simulator**
@@ -142,17 +140,17 @@ Useful for development without access to hardware with Remoteproc support.
142140

143141
```bash
144142
# Create container
145-
./remoteproc-runtime create --bundle testdata/bundle my-container
143+
./dist/remoteproc-runtime create --bundle testdata/bundle my-container
146144

147145
# Start container
148-
./remoteproc-runtime start my-container
146+
./dist/remoteproc-runtime start my-container
149147

150148
# Check state
151-
./remoteproc-runtime state my-container
149+
./dist/remoteproc-runtime state my-container
152150

153151
# Cleanup
154-
./remoteproc-runtime kill my-container
155-
./remoteproc-runtime delete my-container
152+
./dist/remoteproc-runtime kill my-container
153+
./dist/remoteproc-runtime delete my-container
156154
```
157155

158156
## CI/CD

0 commit comments

Comments
 (0)