Skip to content

Commit d4cbc73

Browse files
committed
added build instructions
1 parent 9253b63 commit d4cbc73

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,31 @@
33
This project contains all the software required for creating or participating in a distributed validator cluster for Ethereum using the [SSV project](https://github.com/bloxapp/ssv).
44
It currently supports mainnet, holesky and hoodi - though holesky no longer supports the full validator registration lifecycle since got rekt.
55

6-
## cli
6+
## Development
7+
8+
### Prerequisites
9+
- go 19 or newer
10+
11+
### Building
12+
13+
To build the sidecar from source run:
14+
```go
15+
go build -o ssv-sidecar ./sidecar/cmd/main.go
16+
```
17+
18+
To build the user CLI from source run:
19+
```go
20+
go build -o ssv-dkg ./cli/cmd/main.go
21+
```
22+
23+
## Usage
24+
### cli
725
For users with ETH to stake who wish to create a validator cluster, [read the CLI readme](./cli/README.md)
826

9-
## sidecar
27+
### sidecar
1028
For SSV node operators who wish to opt into distributed key generation opportunities, [read the sidecar readme](./sidecar/README.md)
1129

12-
## tools
30+
### tools
1331
The tools module contains useful applications for interacting with other parts of the project.
1432

15-
[./tools/key_verifier](./tools/key_verifier) is a tool used by the GitHub actions for verifying the keys of operators added to the [operators list](./nodes/operators.json).
33+
[./tools/key_verifier](./tools/key_verifier) is a tool used by the GitHub actions for verifying the keys of operators added to the [operators list](./nodes/operators.json).

0 commit comments

Comments
 (0)