From 1b60dcf722b6b1b56be121940f92a94123b93f03 Mon Sep 17 00:00:00 2001 From: Santiago Lezica Date: Mon, 19 Apr 2021 18:54:47 -0300 Subject: [PATCH] Move build instructions to BUILD.md --- BUILD.md | 31 +++++++++++++++++++++++++++++++ README.md | 32 ++------------------------------ 2 files changed, 33 insertions(+), 30 deletions(-) create mode 100644 BUILD.md diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..9170e10 --- /dev/null +++ b/BUILD.md @@ -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 . -- + ``` + +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. \ No newline at end of file diff --git a/README.md b/README.md index eda8810..0aaea98 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ architecture. Once you have that, run: ``` +chmod +x recovery-tool ./recovery-tool ``` @@ -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 . -- - ``` - -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