Skip to content

Commit 0a80b69

Browse files
authored
Merge pull request #87 from LedgerHQ/y333_241025/update_readme
Update README
2 parents c36949e + 9c32cff commit 0a80b69

File tree

1 file changed

+24
-26
lines changed

1 file changed

+24
-26
lines changed

README.md

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -38,47 +38,45 @@ By using Ledger's own developer tools [Docker image](https://github.com/LedgerHQ
3838

3939
ℹ️ The terminal tab of VSCode will show you what commands the extension runs behind the scene.
4040

41-
## Compilation and load
42-
43-
If you do not wish to use the [VS Code extension](#with-vs-code), you can follow the following steps to setup a development environment on a host running a Debian based Linux distribution (such as Ubuntu).
41+
## With a terminal
4442

4543
### Prerequisites
4644

47-
* Install the [Rust language](https://www.rust-lang.org/)
45+
If you do not wish to use the [VS Code extension](#with-vs-code), you can follow the following steps to setup a development environment on Linux or MacOS.
4846

49-
```bash
50-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
47+
The [ledger-app-dev-tools](https://github.com/LedgerHQ/ledger-app-builder/pkgs/container/ledger-app-builder%2Fledger-app-dev-tools) Docker image contains all the required tools and libraries to build, test and load an application on a device.
48+
49+
You can download it from the ghcr.io docker repository:
50+
51+
```shell
52+
sudo docker pull ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
5153
```
5254

53-
* Install Ledger Rust building tools dependencies
55+
You can then enter into this development environment by executing the following command from the directory of the application (`git` repository):
5456

55-
```bash
56-
# Clang compiler, GCC ARM cross-compiling toolchain
57-
apt install clang gcc-arm-none-eabi gcc-multilib
58-
# Rust nightly toolchain used to compile ledger devices binaries
59-
rustup install nightly-2023-11-10
60-
# Setup the custom nightly Rust toolchain as default
61-
rustup default nightly-2023-11-10
62-
# Install required component of the nightly toolchain
63-
rustup component add rust-src --toolchain nightly-2023-11-10
57+
**Linux (Ubuntu)**
58+
59+
```shell
60+
sudo docker run --rm -ti --privileged -v "/dev/bus/usb:/dev/bus/usb" -v "$(realpath .):/app" ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
6461
```
6562

66-
* Install [ledgerwallet](https://github.com/LedgerHQ/ledgerctl/) and [cargo-ledger](https://github.com/LedgerHQ/cargo-ledger)
63+
**macOS**
6764

68-
```bash
69-
# Install ledgerwallet, a Python dependency of cargo-ledger to sideload binaries on Ledger devices
70-
pip install ledgerwallet
71-
# Install latest cargo-ledger from crates.io
72-
cargo install cargo-ledger
73-
# Run cargo-ledger command to install custom target files on the custom nightly toolchain
74-
cargo ledger setup
65+
```shell
66+
sudo docker run --rm -ti --privileged -v "$(pwd -P):/app" ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
67+
```
68+
69+
**Windows (with PowerShell)**
70+
71+
```shell
72+
docker run --rm -ti --privileged -v "$(Get-Location):/app" ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
7573
```
7674

77-
You are now ready to build the boilerplate app for Ledger devices !
75+
The application's code will be available from inside the docker container, you can proceed to the following compilation steps to build your app.
7876

7977
### Building
8078

81-
Now that you have followed the [prerequisites](#prerequisites) guide, you can build the boilerplate with the following command executed in the root directory of the app.
79+
You can build the boilerplate with the following command executed in the root directory of the app.
8280

8381
```bash
8482
cargo ledger build nanox

0 commit comments

Comments
 (0)