diff --git a/.gitignore b/.gitignore index 44dd8dd9..9a34ba8e 100644 --- a/.gitignore +++ b/.gitignore @@ -29,3 +29,5 @@ __pycache__/ # Doxygen doc/html doc/latex +ledger +build \ No newline at end of file diff --git a/README.md b/README.md index 94cfe927..47d97f8e 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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 ```