sasa/maze32
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
sasa
2026-09-04 11:36:04 +03:00
parent 2aaa1650ae
commit 115a3bd0a1
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -10
View File
@@ -6,7 +6,7 @@ to saved Wi-Fi credentials or starts a fallback provisioning access point.
## Prerequisites ## Prerequisites
- PlatformIO Core installed at `/home/sasa/.platformio/penv/bin/pio`; - PlatformIO Core installed at `$HOME/.platformio/penv/bin/pio`;
- a C11 host compiler available as `cc`; - a C11 host compiler available as `cc`;
- Python 3. - Python 3.
@@ -15,7 +15,7 @@ to saved Wi-Fi credentials or starts a fallback provisioning access point.
Parse the locked PlatformIO configuration: Parse the locked PlatformIO configuration:
```sh ```sh
/home/sasa/.platformio/penv/bin/pio project config $HOME/.platformio/penv/bin/pio project config
``` ```
Run the portable host tests and deterministic asset check: Run the portable host tests and deterministic asset check:
@@ -28,13 +28,13 @@ Build the firmware. The PlatformIO hook checks the application image against
the 2 MiB `factory` partition: the 2 MiB `factory` partition:
```sh ```sh
/home/sasa/.platformio/penv/bin/pio run $HOME/.platformio/penv/bin/pio run
``` ```
Generate compressed assets explicitly when needed: Generate compressed assets explicitly when needed:
```sh ```sh
/home/sasa/.platformio/penv/bin/python scripts/generate_web_assets.py $HOME/.platformio/penv/bin/python scripts/generate_web_assets.py
``` ```
Build the LittleFS image. Asset generation runs automatically before packaging, Build the LittleFS image. Asset generation runs automatically before packaging,
@@ -42,7 +42,7 @@ and the PlatformIO hook checks the image against the 1,984 KiB `littlefs`
partition: partition:
```sh ```sh
/home/sasa/.platformio/penv/bin/pio run --target buildfs $HOME/.platformio/penv/bin/pio run --target buildfs
``` ```
## Device commands ## Device commands
@@ -50,14 +50,14 @@ partition:
Upload the application and LittleFS image: Upload the application and LittleFS image:
```sh ```sh
/home/sasa/.platformio/penv/bin/pio run --target upload $HOME$/.platformio/penv/bin/pio run --target upload
/home/sasa/.platformio/penv/bin/pio run --target uploadfs $HOME$/.platformio/penv/bin/pio run --target uploadfs
``` ```
Monitor startup at 115200 baud: Monitor startup at 115200 baud:
```sh ```sh
/home/sasa/.platformio/penv/bin/pio device monitor $HOME/.platformio/penv/bin/pio device monitor
``` ```
A successful boot reports the firmware version, LittleFS capacity and use, A successful boot reports the firmware version, LittleFS capacity and use,
@@ -90,8 +90,8 @@ SSID, refuses to overwrite unexpected saved credentials, and clears its test
record after verifying fallback recovery: record after verifying fallback recovery:
```sh ```sh
/home/sasa/.platformio/penv/bin/pio run -e milestone-003-device-test $HOME/.platformio/penv/bin/pio run -e milestone-003-device-test
/home/sasa/.platformio/penv/bin/pio run -e milestone-003-device-test --target upload $HOME/.platformio/penv/bin/pio run -e milestone-003-device-test --target upload
``` ```
Restore the normal firmware afterward with the standard upload command. Restore the normal firmware afterward with the standard upload command.