Skip to content

Commit c622ed3

Browse files
committed
docs(README): add section for building Docker images
1 parent 93ec918 commit c622ed3

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ Targets:
110110
build Build all available artefacts (executable, docker image, etc.)
111111
build-go Build node executable for the current environment (default build)
112112
build-go-all Build node executables for all available environments
113+
build-docker Build docker image
113114
Install:
114115
install Install node executable
115116
Test:
@@ -137,6 +138,7 @@ Targets:
137138
Dependencies:
138139
deps Install all the dependencies (tools, etc.)
139140
deps-tparse Install tparse v0.16.0 (github.com/mfridman/tparse@v0.16.0)
141+
deps-heighliner Install heighliner v1.7.1 (github.com/strangelove-ventures/heighliner@v1.7.1)
140142
Help:
141143
help Show this help.
142144
@@ -148,14 +150,23 @@ This Makefile depends on docker. To install it, please follow the instructions:
148150

149151
### Build
150152

151-
To build the `axoned` node, invoke the goal `build` of the `Makefile`:
153+
To build the `axoned` node, invoke the goal `build-go` of the `Makefile`:
152154

153155
```sh
154-
make build
156+
make build-go
155157
```
156158

157159
The binary will be generated under the folder `target/dist`.
158160

161+
### Build a docker image
162+
163+
This project leverages [heighliner](https://github.com/strangelove-ventures/heighliner) to simplify the management and
164+
creation of production-grade container images. To build a Docker image, use the `build-docker` target in the `Makefile`:
165+
166+
```sh
167+
make build-docker
168+
```
169+
159170
### Run a local network
160171

161172
To initialize a local network configuration, invoke the goal `chain-init` of the `Makefile`:

0 commit comments

Comments
 (0)