From 6f2363cf311b7962aabb17eee58caa0060cac2ac Mon Sep 17 00:00:00 2001 From: Evgenii Stratonikov Date: Thu, 30 Jun 2022 15:48:56 +0300 Subject: [PATCH] [#1438] README.md: add build instructions Signed-off-by: Evgenii Stratonikov --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index a96ce8e65..9587f9bef 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,35 @@ platforms will be officially supported after release `1.0`. The latest version of neofs-node works with neofs-contract [v0.13.0](https://github.com/nspcc-dev/neofs-contract/releases/tag/v0.13.0). +# Building + +To make all binaries you need Go 1.17+ and `make`: +``` +make all +``` +The resulting binaries will appear in `bin/` folder. + +To make a specific binary use: +``` +make bin/neofs- +``` +See the list of all available commands in the `cmd` folder. + +## Building with Docker + +Building can also be performed in a container: +``` +make docker/all # build all binaries +make docker/bin/neofs- # build a specific binary +``` + +## Docker images + +To make docker images suitable for use in [neofs-dev-env](https://github.com/nspcc-dev/neofs-dev-env/) use: +``` +make images +``` + # Contributing Feel free to contribute to this project after reading the [contributing