Skip to content

Commit

Permalink
update compile doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Pana committed Oct 18, 2024
1 parent 56a4b28 commit be74f8b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,5 @@ __pycache__/
# Doxygen
doc/html
doc/latex
ledger
build
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,16 @@ Current Features:

## Prerequisites

Be sure to have your environment correctly set up (see [Getting Started](https://developers.ledger.com/docs/nano-app/introduction/)) and [ledgerblue](https://pypi.org/project/ledgerblue/) installed.
Be sure to have your environment correctly set up (see [Getting Started](https://developers.ledger.com/docs/device-app/getting-started)) and [ledgerblue](https://pypi.org/project/ledgerblue/) installed.

## Compilation

```
Developers can use the official Ledger Docker image + VS Code Ledger Dev Tool extension to compile, as detailed in the [official documentation](https://developers.ledger.com/docs/device-app/beginner/vscode-extension).

Or set up the compilation environment manually. This method requires downloading the [Ledger SDK](https://github.com/LedgerHQ/ledger-secure-sdk) and then executing the following commands:

```sh
# Set BOLOS_SDK environment variable to the path of the SDK
make DEBUG=1 # compile optionally with PRINTF
make load # load the app on the Nano using ledgerblue
```
Expand All @@ -26,7 +31,7 @@ make load # load the app on the Nano using ledgerblue

High level documentation such as [APDU](doc/APDU.md), and [commands](doc/COMMANDS.md) are included in the developer documentation which can be generated with [doxygen](https://www.doxygen.nl)

```
```sh
doxygen .doxygen/Doxyfile
```

Expand Down

0 comments on commit be74f8b

Please sign in to comment.