Skip to content

Commit

Permalink
guix: readme: add quick setup guide
Browse files Browse the repository at this point in the history
  • Loading branch information
tobtoht committed Oct 3, 2024
1 parent 21315e3 commit 0149b0a
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions contrib/guix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 0149b0a

Please sign in to comment.