a2nr
/
velxio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(readme): add missing wokwi-boards clone to manual setup 

A user (st_stefanov on Discord) reported the manual setup steps clone
avr8js, wokwi-elements, and rp2040js but skip wokwi-boards. The frontend
imports board.svg assets from wokwi-libs/wokwi-boards/boards/* (ESP32
DevKit V1, ESP32-S3, ESP32-C3, Pi Pico W, etc.), so without that repo
the Vite build fails on missing imports.

Dockerfile.standalone:77 already clones it; the README's Option C
(manual setup) was the only path missing the line. wokwi-boards is
asset-only — no npm install or build step needed.
This commit is contained in:
davidmonterocrespo24 2026-04-25 05:03:47 +02:00
parent 979df2608b
commit fd1cd03a26
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -303,8 +303,12 @@ cd velxio
> git clone --depth=1 https://github.com/wokwi/avr8js.git avr8js > git clone --depth=1 https://github.com/wokwi/avr8js.git avr8js
> git clone --depth=1 https://github.com/wokwi/wokwi-elements.git wokwi-elements > git clone --depth=1 https://github.com/wokwi/wokwi-elements.git wokwi-elements
> git clone --depth=1 https://github.com/wokwi/rp2040js.git rp2040js > git clone --depth=1 https://github.com/wokwi/rp2040js.git rp2040js
> git clone --depth=1 https://github.com/wokwi/wokwi-boards.git wokwi-boards
> cd .. > cd ..
> ``` > ```
> `wokwi-boards` ships static SVG assets imported by the ESP32 / Pi Pico W
> board components — without it the frontend build fails on missing
> `board.svg` imports.
**Build the Wokwi libraries** (required before running the frontend): **Build the Wokwi libraries** (required before running the frontend):
@ -312,6 +316,7 @@ cd velxio
cd wokwi-libs/avr8js && npm install && npm run build && cd ../.. cd wokwi-libs/avr8js && npm install && npm run build && cd ../..
cd wokwi-libs/wokwi-elements && npm install && npm run build && cd ../.. cd wokwi-libs/wokwi-elements && npm install && npm run build && cd ../..
cd wokwi-libs/rp2040js && npm install && npm run build && cd ../.. cd wokwi-libs/rp2040js && npm install && npm run build && cd ../..
# wokwi-boards is asset-only (SVGs) — no install or build needed.
``` ```
```bash ```bash