MyFavMirrors
/
muun-recovery
mirror of https://github.com/muun/recovery.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Move build instructions to BUILD.md

This commit is contained in:
Santiago Lezica 2021-04-19 18:54:47 -03:00
parent 036cfa7f1d
commit 1b60dcf722
2 changed files with 33 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
BUILD.md Normal file
View File

@ -0,0 +1,31 @@
# Building and Auditing
To build the tool locally and run it, you must:
1. Install the [Go](https://golang.org/) toolchain.
2. Clone the repository:
```
git clone https://github.com/muun/recovery
cd recovery
```
3. Run the tool with:
```
go run -mod=vendor . -- <path to your Emergency Kit PDF>
```
To build the tool in all its variants and verify the checksums for the provided binaries, you need to:
1. Install the [Docker](https://www.docker.com/) toolchain and start the daemon.
2. Run this command:
```
make build-checksum-all
```
3. Verify that the printed checksums match those of the downloaded versions, using `sha256sum`
as in the `Makefile`.
We use Docker for these builds to ensure they are reproducible.

32
README.md
View File

@ -28,6 +28,7 @@ architecture.
Once you have that, run:
```
chmod +x recovery-tool
./recovery-tool <path to your Emergency Kit PDF>
```
@ -40,36 +41,7 @@ If you have any questions, we'll be happy to answer them. Contact us at support@
This tool is open-sourced so that auditors can dive into the code, and verify it to their benefit
and everyone else's. We encourage people with the technical knowledge to do this.
To build the tool locally and run it, you must:
1. Install the [Go](https://golang.org/) toolchain.
2. Clone the repository:
```
git clone https://github.com/muun/recovery
cd recovery
```
3. Run the tool with:
```
go run -mod=vendor . -- <path to your Emergency Kit PDF>
```
To build the tool in all its variants and verify the checksums for the above binaries, you need to:
1. Install the [Docker](https://www.docker.com/) toolchain and start the daemon.
2. Run this command:
```
make build-checksum-all
```
3. Verify that the printed checksums match those of the downloaded versions, using `sha256sum`
as in the `Makefile`.
We use Docker for these builds to ensure they are reproducible.
See `BUILD.md` for detailed instructions.
## Questions