Skip to content

docs(advanced): add link to pio cli install instructions #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
negue wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(advanced): add link to pio cli install instructions #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3262888
docs(advanced): add link to pio cli install instructions
negue Oct 5, 2026
f5f34f9
docs(advanced): typo
negue Oct 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/advanced/building.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ You need PlatformIO, Python 3 and Node.js. The host tests additionally need CMak
3.20+, Ninja and GCC. Node is used only by the pre-build step that embeds the
[web UI](#the-embedded-web-ui), but a firmware build stops without it.

To run the `pio` cli you need to [install it first](https://docs.platformio.org/en/latest/core/installation/index.html).

```bash
pio run -e awtrix # ESP32 firmware (the default environment)
pio run -e awtrix_s3_octal # ESP32-S3 firmware, octal PSRAM
Expand Down
4 changes: 3 additions & 1 deletion docs/advanced/simulator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ notifications, or preview the web UI, without touching hardware.

## Build and run

To run the `pio` cli you need to [install it first](https://docs.platformio.org/en/latest/core/installation/index.html).

```bash
pio run -e native_sim
pio run -e native_sim # Building native_sim
.pio/build/native_sim/program # Linux/macOS
.pio\build\native_sim\program.exe # Windows
# then open http://localhost:8080
Expand Down