Skip to content

Commit 9a5025c

Browse files
committed
docs: link to example repo + instructions
1 parent 03b32f6 commit 9a5025c

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,15 @@ Wokwi Simulation API command line interface.
88
npx wokwi-cli [directory]
99
```
1010

11-
The give directory should have a `wokwi.toml` file, as explained in [the documentation](https://docs.wokwi.com/vscode/project-config#wokwitoml).
11+
The given directory should have a `wokwi.toml` file, as explained in [the documentation](https://docs.wokwi.com/vscode/project-config#wokwitoml).
12+
13+
For example, you could clone the [ESP32 Hello World binaries repo](https://github.com/wokwi/esp-idf-hello-world), and point the CLI at the `esp-idf-hello-world` directory:
14+
15+
```bash
16+
git clone https://github.com/wokwi/esp-idf-hello-world
17+
cd esp-idf-hello-world
18+
npx wokwi-cli .
19+
```
1220

1321
## License
1422

0 commit comments

Comments
 (0)