|
1 | 1 | # Installation |
2 | 2 |
|
3 | | -MicroPythonOS can be installed on supported microcontrollers (e.g., ESP32) or desktop systems (Linux, potentially MacOS). For detailed instructions, visit [install.micropythonos.com](https://install.micropythonos.com). |
| 3 | +MicroPythonOS can be installed on supported microcontrollers (e.g., ESP32) and on desktop systems (Linux, Raspberry Pi, MacOS, etc). |
4 | 4 |
|
5 | | -## Installing on ESP32 |
| 5 | +If you're a developer, you can [build it yourself and install from source](../building/index.md) |
6 | 6 |
|
7 | | -1. **Prepare the Environment**: |
8 | | -```bash |
9 | | -mkdir ~/MicroPythonOS |
10 | | -cd ~/MicroPythonOS |
11 | | -git clone https://github.com/MicroPythonOS/MicroPythonOS.git |
12 | | -git clone https://github.com/MicroPythonOS/freezeFS |
13 | | -git clone https://github.com/cnadler86/micropython-camera-API |
14 | | -echo 'include("~/MicroPythonOS/lvgl_micropython/build/manifest.py")' >> micropython-camera-API/src/manifest.py |
15 | | -git clone https://github.com/MicroPythonOS/lvgl_micropython |
16 | | -git clone https://github.com/MicroPythonOS/secp256k1-embedded-ecdh |
17 | | -``` |
| 7 | +To simply install prebuilt software, read on! |
18 | 8 |
|
19 | | -2. **Build for ESP32**: |
20 | | -```bash |
21 | | -cd ~/MicroPythonOS/MicroPythonOS |
22 | | -./scripts/build_lvgl_micropython.sh esp32 prod |
23 | | -``` |
24 | | - For a development build (no preinstalled files): |
25 | | -```bash |
26 | | -./scripts/build_lvgl_micropython.sh esp32 dev |
27 | | -``` |
| 9 | +## Installing on ESP32 |
28 | 10 |
|
29 | | -3. **Flash to ESP32**: |
30 | | - - Put your ESP32 in bootloader mode (long-press the BOOT button if running MicroPythonOS). |
31 | | - - Flash the firmware: |
32 | | -```bash |
33 | | -./scripts/flash_over_usb.sh |
34 | | -``` |
35 | | - - For a development build, install files manually: |
36 | | -```bash |
37 | | -./scripts/install.sh |
38 | | -``` |
| 11 | +Just use the [WebSerial installer at install.micropythonos.com](https://install.micropythonos.com). |
39 | 12 |
|
40 | 13 | ## Installing on Desktop (Linux/MacOS) |
41 | 14 |
|
42 | | -1. **Install Dependencies** (Linux): |
43 | | -```bash |
44 | | -sudo apt install libv4l-dev # For webcam support |
45 | | -``` |
46 | | - See [lvgl-micropython](https://github.com/MicroPythonOS/lvgl-micropython) for additional dependencies. |
| 15 | +Download the [latest release for desktop](https://github.com/MicroPythonOS/MicroPythonOS/releases). |
| 16 | + |
| 17 | +Here we'll assume you saved it in /tmp/MicroPythonOS_amd64_Linux_0.0.8 |
| 18 | + |
| 19 | +Get the internal_filesystem files: |
47 | 20 |
|
48 | | -2. **Build for Desktop**: |
49 | | -```bash |
50 | | -cd ~/MicroPythonOS/MicroPythonOS |
51 | | -./scripts/build_lvgl_micropython.sh unix dev |
52 | 21 | ``` |
53 | | - For MacOS (untested): |
54 | | -```bash |
55 | | -./scripts/build_lvgl_micropython.sh macOS dev |
| 22 | +git clone https://github.com/MicroPythonOS/MicroPythonOS.git |
| 23 | +cd MicroPythonOS/ |
| 24 | +cd internal_filesystem/ |
56 | 25 | ``` |
57 | 26 |
|
58 | | -3. **Run on Desktop**: |
59 | | - - Download a release (e.g., `MicroPythonOS_amd64_Linux_0.0.6`) or use your build. |
60 | | - - Run: |
61 | | -```bash |
62 | | -cd internal_filesystem/ |
63 | | -/path/to/MicroPythonOS_amd64_Linux_0.0.6 -X heapsize=32M -v -i -c "$(cat boot_unix.py main.py)" |
| 27 | +Now run it by starting the entry points, boot_unix.py and main.py: |
| 28 | + |
64 | 29 | ``` |
65 | | - - See `scripts/run_on_desktop.sh` for options like fullscreen or direct app launch. |
| 30 | +/tmp/MicroPythonOS_amd64_Linux_0.0.8 -X heapsize=32M -v -i -c "$(cat boot_unix.py main.py)" |
| 31 | +``` |
| 32 | + |
| 33 | +You can also check out `scripts/run_desktop.sh` for more examples, such as immediately starting an app or starting fullscreen. |
66 | 34 |
|
67 | 35 | ## Next Steps |
68 | 36 |
|
|
0 commit comments