Skip to content

Commit c77c47d

Browse files
Add WebAssembly info
1 parent 7c50e39 commit c77c47d

4 files changed

Lines changed: 21 additions & 5 deletions

File tree

docs/getting-started/running.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Running it
22

3-
MicroPythonOS can run on supported microcontrollers (e.g., ESP32) and on desktop systems (Linux, Raspberry Pi, MacOS, Windows etc).
3+
MicroPythonOS can run on supported microcontrollers (e.g., ESP32), on desktop systems (Linux, Raspberry Pi, MacOS, Windows), and in a web browser via WebAssembly.
44

55
To install prebuilt software, read on!
66

@@ -18,6 +18,12 @@ On desktop you can choose how deep you want to go: run a pre-built binary, devel
1818

1919
See [Running on Desktop](../os-development/running-on-desktop.md) for detailed steps.
2020

21+
## Running in the browser
22+
23+
Open **[web.micropythonos.com](https://web.micropythonos.com/)** for the latest release, or **[micropythonos.github.io/MicroPythonOS](https://micropythonos.github.io/MicroPythonOS/)** for the bleeding-edge main branch. No install required.
24+
25+
See [Using the Web Port](../web-port/using.md) for details and limitations.
26+
2127
## Next Steps
2228

2329
- Explore [Built-in Apps](../apps/built-in-apps.md) to get started with the system.

docs/getting-started/supported-hardware.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ MicroPythonOS runs on a variety of platforms, from microcontrollers to desktops.
2323
- [SQUiXL](https://squixl.io): Fully Supported
2424
- [Waveshare ESP32-S3-Touch-LCD-2](https://www.waveshare.com/wiki/ESP32-S3-Touch-LCD-2): Fully Supported
2525

26+
## WebAssembly (Browser)
27+
28+
- **Latest release**: [web.micropythonos.com](https://web.micropythonos.com/)
29+
- **Main branch CI**: [micropythonos.github.io/MicroPythonOS](https://micropythonos.github.io/MicroPythonOS/)
30+
- Runs entirely in a modern desktop browser — no install, no flash.
31+
- Built from source with `./scripts/build_mpos.sh web` (requires [Emscripten SDK](../web-port/developer/#prerequisites)).
32+
- See [CI config](https://github.com/MicroPythonOS/MicroPythonOS/blob/main/.github/workflows/web-pages.yml) for automated build details.
33+
2634
## Desktop Computers
2735

2836
- **Linux**: Supported using SDL for display handling.

docs/os-development/compiling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Usage:
3232
./scripts/build_mpos.sh <target system>
3333
```
3434

35-
**Target systems**: `esp32`, `esp32s3`, `unix` (= Linux) and `macOS`
35+
**Target systems**: `esp32`, `esp32s3`, `unix` (= Linux), `macOS` and `web` (= WebAssembly)
3636

3737
**Examples**:
3838

docs/web-port/using.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@ Open that link in a modern desktop browser and the OS will boot directly into th
1515
The web port stores writable data (`/data` and `/apps`) in the browser's IndexedDB. The read-only system files are baked into the WebAssembly preload. If you want a completely clean start — for example, after a major upstream change or to clear stale app data — you need to wipe the stored filesystem:
1616

1717
1. Open the developer tools (`F12`).
18-
2. Go to **Application****Storage****Local Storage / IndexedDB** (or the equivalent in your browser).
19-
3. Clear site data / delete everything for `micropythonos.github.io`.
20-
4. Close the tab or press `F5` to reload the page.
18+
2. Go to **Application****Storage** (Chromium) or **Storage****IndexedDB** (Firefox).
19+
3. Clear site data for the origin (e.g. `micropythonos.github.io` or `web.micropythonos.com`).
20+
4. Reload the page.
21+
22+
Alternatively, you can update installed apps through the built-in App Store without clearing storage.
2123

2224
After the reload the OS will boot with a fresh filesystem. The bundled demo apps will be re-seeded on first run.
2325

0 commit comments

Comments
 (0)