From: tobtoht <tob@featherwallet.org>
Date: Thu, 3 Oct 2024 15:23:37 +0000 (+0200)
Subject: guix: readme: add quick setup guide
X-Git-Url: https://git.nutra.tk/v2?a=commitdiff_plain;h=0149b0ae9cc01db4de6b51c2ae41fe65b85623b0;p=gamesguru%2Ffeather.git

guix: readme: add quick setup guide
---

diff --git a/contrib/guix/README.md b/contrib/guix/README.md
index e5e6e9eb..7b407db1 100644
--- a/contrib/guix/README.md
+++ b/contrib/guix/README.md
@@ -23,11 +23,34 @@ You can submit attestations to the [feather-sigs](https://github.com/feather-wal
 
 # Requirements
 
-Conservatively, you will need an x86_64 machine with:
+- any Linux distribution
+- 50 GB of free disk space
+- 4 or more cores recommended
+- 2 GB RAM per thread
+
+# Quick setup
+
+If you're just here to get a build running (e.g. to test your changes) and quickly want to get up and running:
+
+```bash
+# Install guix
+$ apt install guix  # ubuntu 22.04, debian 11, or later
+or
+# use the install script: https://guix.gnu.org/manual/en/html_node/Binary-Installation.html
+
+# Clone the repo
+$ git clone https://github.com/feather-wallet/feather
+$ cd feather
+
+# Run the build
+$ ./contrib/guix/guix-build  # this will build all targets using all available cores
+or
+$ JOBS=N ./contrib/guix/guix-build  # this will limit the amount of threads to N
+or
+$ HOSTS="x86_64-linux-gnu" ./contrib/guix/guix-build  # to only build the x86_64 linux target
+```
 
-- 16GB of free disk space on the partition that /gnu/store will reside in
-- 8GB of free disk space **per platform triple** you're planning on building
-  (see the `HOSTS` [environment variable description][env-vars-list])
+If you're looking to submit an attestation, follow the instructions below.
 
 # Installation and Setup