Merge pull request #4 from okwn/docs/docker-install-hint

docs: clarify docker run flags for first-time users
This commit is contained in:
OKWN 2026-05-24 00:49:10 +03:00 committed by GitHub
commit ade1c12319
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 2 deletions

View File

@ -76,8 +76,8 @@ RuView turns ordinary WiFi into a contactless sensor. A $9 ESP32 board reads the
```bash
# Option 1: Docker (simulated data, no hardware needed)
docker pull ruvnet/wifi-densepose:latest
docker run -p 3000:3000 ruvnet/wifi-densepose:latest
docker pull ruvnet/wifi-densepose:latest # may take a minute
docker run -p 3000:3000 ruvnet/wifi-densepose:latest # use -it for interactive; if port 3000 is taken, try -p 3001:3000
# Open http://localhost:3000
# Option 2: Live sensing with ESP32-S3 hardware ($9)
@ -589,3 +589,11 @@ MIT License — see [LICENSE](LICENSE) for details.
---
**WiFi DensePose** — Privacy-preserving human pose estimation through WiFi signals.
## Windows Note
If running on Windows with Docker Desktop, pass CLI arguments differently:
```
docker run -p 3000:3000 ruvnet/wifi-densepose:latest -- --help
```
On Windows, use `--` to pass arguments through the Docker container to the binary inside.