Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve build instructions #224

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve build instructions #224

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,23 @@ You can get pre-releases in two ways (*THESE ARE UNVETTED DEVELOPMENT RELEASES*)
- Install Docker CE
- Instructions can be found here: https://docs.docker.com/install/

- We typically use Ubuntu or MacOS. Install the following packages:
- We typically use Ubuntu. Install the following packages:
```sh
sudo apt update && apt-get -y install build-essential git wget cmake \
libssl-dev libgmp-dev autoconf libtool
```

Or for MacOS, install the following:
```sh
brew install python@3.11 cmake
echo 'export PATH="$PATH:/opt/homebrew/opt/python@3.11/libexec/bin"' >> .zprofile
source ~/.zshrc
```

- Install [poetry](https://python-poetry.org/docs/#installing-with-the-official-installer). This simplifies python environments

```sh
https://python-poetry.org/docs/#installing-with-the-official-installer
curl -sSL https://install.python-poetry.org | python3 -
```

- Install [volta](https://docs.volta.sh/guide/getting-started)
Expand All @@ -47,6 +54,7 @@ You can get pre-releases in two ways (*THESE ARE UNVETTED DEVELOPMENT RELEASES*)
```

- You will need python 3 and then run
- `poetry shell`
- `make deps`

- The current repository keeps track of Ledger's SDK but it is possible to override it by changing the git submodule.
Expand Down