Skip to content

Commit 332c73d

Browse files
Improve docs
1 parent f71c9cb commit 332c73d

5 files changed

Lines changed: 17 additions & 6 deletions

File tree

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Installation
1+
# Running it
22

33
MicroPythonOS can be installed on supported microcontrollers (e.g., ESP32) and on desktop systems (Linux, Raspberry Pi, MacOS, etc).
44

55
To simply install prebuilt software, read on!
66

7-
## Installing on ESP32
7+
## Running on ESP32
88

99
Just use the [WebSerial installer at install.micropythonos.com](https://install.micropythonos.com).
1010

docs/os-development/installing-on-esp32.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ But if you need to install a version that's not available there, or you built yo
3838
3939
In development, you probably want to override the "frozen" libraries and apps that are compiled in, and replace them with source files, which you can edit.
4040
41+
This makes MicroPythonOS startup a lot slower, as the Python scripts have to be compiled at runtime instead of at build time.
42+
But once MicroPythonOS and the code you're testing has loaded, the speed will be normal again.
43+
4144
There's a convenient script that will do this for you.
4245
4346
Usage:
337 KB
Loading

docs/os-development/running-on-desktop.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,17 @@
3636
```
3737
</pre>
3838

39-
On MacOS, if you get an error about a missing /opt/homebrew/opt/libffi/lib/libffi.8.dylib then fix that with: `brew install libffi`
39+
### Notes on MacOS
4040

41-
## Testing on Desktop
41+
If you get an error about a missing /opt/homebrew/opt/libffi/lib/libffi.8.dylib then fix that with: `brew install libffi`
42+
43+
If you get an error about the code being unsigned, then allow it like this:
44+
45+
![Allow Anyway on MacOS](macos-allow-anyway.png)
46+
47+
48+
49+
## Making Changes on Desktop
4250

4351
You'll notice that whenever you change a file in `internal_filesystem/`, the changes are immediately visible on desktop when you reload the file or restart the app.
4452

@@ -56,7 +64,7 @@ When you run `./scripts/run_desktop.sh`, the OS runs the MicroPythonOS scripts *
5664
4. See your changes immediately!
5765

5866

59-
## Testing on Hardware
67+
## Making Changes on ESP32
6068

6169
Once you've tested your changes on desktop and they work correctly, or you're doing things you can't test on desktop, then you can deploy to physical hardware.
6270

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ nav:
4040
- Overview: overview.md
4141
- Getting Started:
4242
- Overview: getting-started/index.md
43-
- Installation: getting-started/installation.md
43+
- Running: getting-started/running.md
4444
- Supported Hardware: getting-started/supported-hardware.md
4545
- Apps:
4646
- Overview: apps/index.md

0 commit comments

Comments
 (0)