From 38784109b9a0233978a5999039eb0cf627761c9a Mon Sep 17 00:00:00 2001
From: Coline <coline.seguret@ledger.fr>
Date: Mon, 4 Jul 2022 13:52:18 +0200
Subject: [PATCH] docs: readme in speculos tests

---
 tests/speculos/README.md | 40 +++++++++++++++++++++++++---------------
 1 file changed, 25 insertions(+), 15 deletions(-)

diff --git a/tests/speculos/README.md b/tests/speculos/README.md
index 8ff6e84..6cca81b 100644
--- a/tests/speculos/README.md
+++ b/tests/speculos/README.md
@@ -17,23 +17,33 @@ python3 -m pip install --extra-index-url https://test.pypi.org/simple/ -r requir
 
 ## Usage
 
-Given the requirements are installed, just do:
+### Compilation app
 
-```
-pytest tests/speculos/
+Go to the root of the repository:
+```sh
+make DEBUG=1 NFT_TESTING_KEY=1 BOLOS_SDK=$NANOX_SDK
 ```
 
-## Tests by APDU
+Given the requirements are installed, just do (by default command):
 
-you will find the list of apdu [here](../../doc/apdu.md)
+```
+cd tests/speculos/
+pytest
+```
 
-- Get
-  - GET APP CONFIGURATION ( 1 test )
-    - Get the configuration
-  - GET ETH PUBLIC ADDRESS ( 3 tests )
-    - Ether coin without display
-    - Dai coin with display
-    - Dai coin with display and reject
-  - GET ETH2 PUBLIC KEY
-    - [ ] Test get key
-    - [ ] Test get key with display
\ No newline at end of file
+### Custom options
+- **--model:**  "nanos", "nanox", "nanosp" | default: "nanos"
+- **--display:** "qt", "headless"          | default: "qt"
+- **--path:** the path of the binary app   | default: path of makefile compilation
+
+## Example
+
+With `nanox` binary app:
+```sh
+# the --path is variable to where you put your binary
+
+pytest --model nanox --path ./elfs/nanox.elf
+
+# Execute specific test:
+pytest --model nanox --path ./elfs/nanox.elf test_pubkey_cmd.py
+```
\ No newline at end of file