Skip to content

Commit 44275f6

Browse files
committed
docs : Extend main README Quick start section.
1 parent f96692a commit 44275f6

1 file changed

Lines changed: 32 additions & 3 deletions

File tree

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,43 @@ This repository contains all the drivers for the main components of the [STeaMi]
3131

3232

3333
## Quick start
34-
Use mpremote to quickly run a driver example without installing anything on the board.
34+
35+
Run a driver example on your STeaMi board without installing anything permanently.
36+
37+
### Prerequisites
38+
39+
* A STeaMi board running MicroPython
40+
* A USB cable to connect the board to your computer
41+
* Python installed on your computer
42+
43+
### 1. Install `mpremote`
44+
45+
`mpremote` is the official MicroPython tool to interact with your board.
3546

3647
```bash
3748
pip install mpremote
38-
mpremote mount lib/ism330dl run lib/ism330dl/examples/basic_read.py
3949
```
4050

41-
This mounts the driver temporarily and executes an example directly on the STeaMi board.
51+
### 2. Connect your board
52+
53+
Plug your STeaMi board via USB.
54+
55+
To verify that it is detected:
56+
57+
```bash
58+
mpremote connect list
59+
```
60+
61+
You should see a serial device (e.g. `/dev/ttyUSB0` on Linux or `COM3` on Windows).
62+
63+
64+
### 3. Run an example
65+
66+
You can run a driver example directly on the board without copying files:
67+
68+
```bash
69+
mpremote mount lib/ism330dl run lib/ism330dl/examples/basic_read.py
70+
```
4271

4372
## Installation
4473

0 commit comments

Comments
 (0)