Skip to content

Commit

Permalink
Updating readme with additional build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
joe-dakota committed Jun 12, 2024
1 parent eb02ff4 commit 8f7a473
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,43 @@ The format of the key mappings JSON file should be similar to
}
]
}

```

# Build

## Install Go 1.21 or higher:

Currently, recovery uses Go 1.21 to compile the code.

Install [Go 1.21](https://go.dev/doc/install) by following instructions there, e.g.:

```sh
wget https://go.dev/dl/go1.21.3.linux-amd64.tar.gz
sudo tar xzvf go1.21.3.linux-amd64.tar.gz -C /usr/local/
export PATH=$PATH:/usr/local/go/bin
```

Verify the installation by typing `go version` in your terminal.

```sh
$ go version
go version go1.21.3 darwin/amd64
```

## Build Recovery

In order to build `recovery` you need the source code. Either [download the source of a release](https://github.com/dakota-xyz/recovery/releases) or [clone the git repository](https://github.com/dakota-xyz/recovery).

Build `recovery` from the source code:

```
cd recovery
make build
```

After building, you should see a new executable file `recovery/build/recovery`.

# Example usage

```bash
Expand Down

0 comments on commit 8f7a473

Please sign in to comment.