Skip to content

Commit

Permalink
link app description to the hub
Browse files Browse the repository at this point in the history
Add description to install via the hub
  • Loading branch information
ainhoa-a authored and ftheirs committed Dec 11, 2023
1 parent ae9ce3a commit 2583789
Showing 1 changed file with 27 additions and 10 deletions.
37 changes: 27 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,9 @@ _Please visit our website at [zondax.ch](https://www.zondax.ch)_

**This app is still work in progress!**

This project contains the Zcash app for Ledger Nano S, S+ and X.

- Ledger BOLOS app
- Specs / Documentation
- C++ unit tests
- Rust unit tests
- Zemu tests
## Description of the Project
Welcome to the Ledger Zcash app repository developed by Zondax. This project contains the Zcash application for Ledger Nano S+ and X, providing users with the ability to securely manage their ZEC assets.
This application supports sapling, enabling transfers between shielded and non shielded addresses.

## ATTENTION

Expand All @@ -30,16 +26,28 @@ Please:
- **Do not use a Ledger device with funds for development purposes.**
- **Have a separate and marked device that is used ONLY for development and testing**

Tip:
This repository contains

- Ledger BOLOS app
- Specs / Documentation
- C++ unit tests
- Rust unit tests
- Zemu tests

Tip:
- In releases, you will find a precompiled test app. If you are just curious, you can run `installer_s.sh` and avoid building.

## Download and install

*Once the app is approved by Ledger, it will be available in their app store (Ledger Live).
You can get builds generated by CircleCI from the release tab. THESE ARE UNVETTED DEVELOPMENT RELEASES*

Download a release from here (https://github.com/Zondax/ledger-zcash/releases). You only need `zxtool.sh`
With our Zondax Hub you can install asset apps to your Ledger device and test them. This can be done with both released and unreleased versions developed by the zondax team. To install the Ledger Zcash App on your Ledger device, you can simply:
1. Go to http://hub.zondax.ch/
2. Connect your wallet
3. Install the app

Another way to install the app is by downloading the installer script from the release page (https://github.com/Zondax/ledger-zcash/releases) and follow these commands. You only need `zxtool.sh`

If the file is not executable, run
```sh
Expand All @@ -52,8 +60,14 @@ then run:
./installer_s.sh load
```

# Development
## Troubleshooting
If you encounter any issues while using the Ledger Zcash App, please create and issue in this repository and the team will review it. You can also send an email to [email protected]

## Contact Information/Support
For support, feedback, or inquiries, please reach out to us at: [email protected]


# Development
## Preconditions

- Be sure you checkout submodules too:
Expand Down Expand Up @@ -212,3 +226,6 @@ The Makefile will build the firmware in a docker container and leave the binary
## APDU Specifications

- [APDU Protocol](docs/APDUSPEC.md)
```
make load # Builds and loads the app to the device
```

0 comments on commit 2583789

Please sign in to comment.