Merge pull request #147 from LedgerHQ/iar/readme_update

README update

README.md

@@ -1,28 +1,201 @@
+[![Ensure compliance with Ledger guidelines](https://github.com/LedgerHQ/app-monero/actions/workflows/guidelines_enforcer.yml/badge.svg?branch=develop)](https://github.com/LedgerHQ/app-monero/actions/workflows/guidelines_enforcer.yml) [![Build and run functional tests using ragger through reusable workflow](https://github.com/LedgerHQ/app-monero/actions/workflows/build_and_functional_tests.yml/badge.svg?branch=develop)](https://github.com/LedgerHQ/app-monero/actions/workflows/build_and_functional_tests.yml)
+
 # Monero Ledger App
 
 Monero wallet application for all Ledger devices.
 
-## Install
+## Quick start guide
+
+### With VSCode
+
+You can quickly setup a convenient environment to build and test your application by using [Ledger's VSCode developer tools extension](https://marketplace.visualstudio.com/items?itemName=LedgerHQ.ledger-dev-tools) which leverages the [ledger-app-dev-tools](https://github.com/LedgerHQ/ledger-app-builder/pkgs/container/ledger-app-builder%2Fledger-app-dev-tools) docker image.
+
+It will allow you, whether you are developing on macOS, Windows or Linux to quickly **build** your apps, **test** them on **Speculos** and **load** them on any supported device.
+
+* Install and run [Docker](https://www.docker.com/products/docker-desktop/).
+* Make sure you have an X11 server running :
+    * On Ubuntu Linux, it should be running by default.
+    * On macOS, install and launch [XQuartz](https://www.xquartz.org/) (make sure to go to XQuartz > Preferences > Security and check "Allow client connections").
+    * On Windows, install and launch [VcXsrv](https://sourceforge.net/projects/vcxsrv/) (make sure to configure it to disable access control).
+* Install [VScode](https://code.visualstudio.com/download) and add [Ledger's extension](https://marketplace.visualstudio.com/items?itemName=LedgerHQ.ledger-dev-tools).
+* Open a terminal and clone `app-monero` with `git clone [email protected]:LedgerHQ/app-monero.git`.
+* Open the `app-monero` folder with VSCode.
+* Use Ledger extension's sidebar menu or open the tasks menu with `ctrl + shift + b` (`command + shift + b` on a Mac) to conveniently execute actions :
+    * Build the app for the device model of your choice with `Build`.
+    * Test your binary on [Speculos](https://github.com/LedgerHQ/speculos) with `Run with Speculos`.
+    * You can also run functional tests, load the app on a physical device, and more.
+
+:information_source: The terminal tab of VSCode will show you what commands the extension runs behind the scene.
+
+### With a terminal
+
+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.
+
+You can download it from the ghcr.io docker repository:
+
+```shell
+sudo docker pull ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
+```
+
+You can then enter this development environment by executing the following command from the directory of the application `git` repository:
+
+**Linux (Ubuntu)**
+
+```shell
+sudo docker run --rm -ti --user "$(id -u):$(id -g)" --privileged -v "/dev/bus/usb:/dev/bus/usb" -v "$(realpath .):/app" ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
+```
+
+**macOS**
+
+```shell
+sudo docker run  --rm -ti --user "$(id -u):$(id -g)" --privileged -v "$(pwd -P):/app" ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
+```
+
+**Windows (with PowerShell)**
+
+```shell
+docker run --rm -ti --privileged -v "$(Get-Location):/app" ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
+```
 
-### Prerequisite
+The application's code will be available from inside the docker container, you can proceed to the following compilation steps to build your app.
 
-Be sure to have your environment correctly set up (see [Getting Started](https://ledger.readthedocs.io/en/latest/userspace/getting_started.html)) and [ledgerblue](https://pypi.org/project/ledgerblue/) installed.
+## Compilation and load
 
+To easily setup a development environment for compilation and loading on a physical device, you can use the [VSCode integration](#with-vscode) whether you are on Linux, macOS or Windows.
+
+If you prefer using a terminal to perform the steps manually, you can use the guide below.
 
 ### Compilation
 
-In order to use the app with the Monero client, you need to compile in debug mode:
+Setup a compilation environment by following the [shell with docker approach](#with-a-terminal).
+
+From inside the container, use the following command to build the app :
+
+```shell
+make DEBUG=1  # compile optionally with PRINTF
+```
+
+You can choose which device to compile and load for by setting the `BOLOS_SDK` environment variable to the following values :
+
+* `BOLOS_SDK=$NANOX_SDK`
+* `BOLOS_SDK=$NANOSP_SDK`
+* `BOLOS_SDK=$STAX_SDK`
+
+By default this variable is set to build/load for Nano S+.
+
+### Loading on a physical device
+
+This step will vary slightly depending on your platform.
+
+:information_source: Your physical device must be connected, unlocked and the screen showing the dashboard (not inside an application).
+
+**Linux (Ubuntu)**
+
+First make sure you have the proper udev rules added on your host :
+
+```shell
+# Run these commands on your host, from the app's source folder.
+sudo cp .vscode/20-ledger.ledgerblue.rules /etc/udev/rules.d/
+sudo udevadm control --reload-rules
+sudo udevadm trigger
+```
+
+Then once you have [opened a terminal](#with-a-terminal) in the `app-builder` image and [built the app](#compilation-and-load) for the device you want, run the following command :
 
+```shell
+# Run this command from the app-builder container terminal.
+make load    # load the app on a Nano S+ by default
 ```
-make DEBUG=1
-make load  # load the app on the Nano using ledgerblue
+
+[Setting the BOLOS_SDK environment variable](#compilation-and-load) will allow you to load on whichever supported device you want.
+
+**macOS / Windows (with PowerShell)**
+
+:information_source: It is assumed you have [Python](https://www.python.org/downloads/) installed on your computer.
+
+Run these commands on your host from the app's source folder once you have [built the app](#compilation-and-load) for the device you want :
+
+```shell
+# Install Python virtualenv
+python3 -m pip install virtualenv
+# Create the 'ledger' virtualenv
+python3 -m virtualenv ledger
+```
+
+Enter the Python virtual environment
+
+* macOS : `source ledger/bin/activate`
+* Windows : `.\ledger\Scripts\Activate.ps1`
+
+```shell
+# Install Ledgerblue (tool to load the app)
+python3 -m pip install ledgerblue
+# Load the app.
+python3 -m ledgerblue.runScript --scp --fileName bin/app.apdu --elfFile bin/app.elf
+```
+
+## Test
+
+The monero app comes with functional tests implemented with Ledger's [Ragger](https://github.com/LedgerHQ/ragger) test framework.
+
+### macOS / Windows
+
+To test your app on macOS or Windows, it is recommended to use [Ledger's VS Code extension](#with-vscode) to quickly setup a working test environment.
+
+You can use the following sequence of tasks and commands (all accessible in the **extension sidebar menu**) :
+
+* `Select build target`
+* `Build app`
+
+Then you can choose to execute the functional tests :
+
+* Use `Run tests`.
+
+Or simply run the app on the Speculos emulator :
+
+* `Run with Speculos`.
+
+### Linux (Ubuntu)
+
+On Linux, you can use [Ledger's VS Code extension](#with-vscode) to run the tests. If you prefer not to, open a terminal and follow the steps below.
+
+Install the tests requirements :
+
+```shell
+pip install -r tests/requirements.txt
+```
+
+Then you can :
+
+Run the functional tests (here for nanos+ but available for any device once you have built the binaries) :
+
+```shell
+pytest tests/ --tb=short -v --device nanosp
 ```
 
-Note that it's for testing only.
-For production usage, use the application provided by the [Ledger Live](https://www.ledger.com/ledger-live/download/) manager.
+Or run your app directly with Speculos
+
+```shell
+speculos --model nanosp build/nanos2/bin/app.elf
+```
+
+## Documentation
+
+- Application [APDU specification](doc/developer/blue-app-commands.rst).
+
+## Continuous Integration
+
+The flow processed in [GitHub Actions](https://github.com/features/actions) is the following:
+
+- Ledger guidelines enforcer which verifies that an app is compliant with Ledger guidelines. The successful completion of this reusable workflow is a mandatory step for an app to be available on the Ledger application store. More information on the guidelines can be found in the repository [ledger-app-workflow](https://github.com/LedgerHQ/ledger-app-workflows)
+- Code formatting with [clang-format](http://clang.llvm.org/docs/ClangFormat.html)
+- Compilation of the application for all Ledger hardware in [ledger-app-builder](https://github.com/LedgerHQ/ledger-app-builder)
+- End-to-end tests with [Speculos](https://github.com/LedgerHQ/speculos) emulator and [ragger](https://github.com/LedgerHQ/ragger) (see [tests/](tests/))
 
 ## Useful links
 
 * Monero client CLI or GUI - [https://web.getmonero.org/downloads/](https://web.getmonero.org/downloads/)
 
-* Ledger's developer documentation - [https://ledger.readthedocs.io](https://ledger.readthedocs.io)
+* Monero GitHub - [https://github.com/monero-project/monero](https://github.com/monero-project/monero)
+
+* Ledger Device Apps's developer documentation - [https://developers.ledger.com/docs/device-app/getting-started](https://developers.ledger.com/docs/device-app/getting-started)