Skip to content

Commit 78e2ec0

Browse files
ThomasFarstrikeThomasFarstrike
committed
More docs
1 parent 26021d1 commit 78e2ec0

File tree

3 files changed

+140
-76
lines changed

3 files changed

+140
-76
lines changed

‎docs/building/desktop.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Building for Desktop
2+
3+
MicroPythonOS can be built to run as an application on Linux desktops (fully supported) or MacOS (untested).
4+
5+
## Prerequisites
6+
7+
- Install dependencies (Linux):
8+
```bash
9+
sudo apt install libv4l-dev # For webcam support
10+
```
11+
- See [lvgl-micropython](https://github.com/MicroPythonOS/lvgl-micropython) for additional requirements.
12+
- Clone repositories as described in [Building for ESP32](esp32.md).
13+
14+
## Build Process
15+
16+
1. **Navigate to the Repository**:
17+
```bash
18+
cd ~/MicroPythonOS/MicroPythonOS
19+
```
20+
21+
2. **Build for Linux**:
22+
```bash
23+
./scripts/build_lvgl_micropython.sh unix dev
24+
```
25+
26+
3. **Build for MacOS** (untested):
27+
```bash
28+
./scripts/build_lvgl_micropython.sh macOS dev
29+
```
30+
31+
## Running on Desktop
32+
33+
1. Download a release (e.g., `MicroPythonOS_amd64_Linux_0.0.6`) or use your build.
34+
2. Run the application:
35+
```bash
36+
cd internal_filesystem/
37+
/path/to/MicroPythonOS_amd64_Linux_0.0.6 -X heapsize=32M -v -i -c "$(cat boot_unix.py main.py)"
38+
```
39+
3. Check `scripts/run_on_desktop.sh` for options like fullscreen or direct app launch.
40+
41+
## Notes
42+
43+
- Linux is fully supported; MacOS support is experimental.
44+
- See [Supported Hardware](../getting-started/supported-hardware.md) for platform details.

‎docs/building/esp32.md‎

Lines changed: 44 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,47 @@ Build MicroPythonOS for ESP32 microcontrollers, such as the Waveshare ESP32-S3-T
55
## Prerequisites
66

77
- Clone the required repositories:
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
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+
```
18+
19+
## Build Process
20+
21+
1. **Navigate to the Repository**:
22+
```bash
23+
cd ~/MicroPythonOS/MicroPythonOS
24+
```
25+
26+
2. **Build for Production** (includes preinstalled files):
27+
```bash
28+
./scripts/build_lvgl_micropython.sh esp32 prod
29+
```
30+
31+
3. **Build for Development** (no preinstalled files):
32+
```bash
33+
./scripts/build_lvgl_micropython.sh esp32 dev
34+
```
35+
36+
## Flashing to ESP32
37+
38+
1. Put your ESP32 in bootloader mode (long-press the BOOT button if running MicroPythonOS).
39+
2. Flash the firmware:
40+
```bash
41+
./scripts/flash_over_usb.sh
42+
```
43+
3. For a development build, install files manually:
44+
```bash
45+
./scripts/install.sh
46+
```
47+
48+
## Notes
49+
50+
- Ensure your ESP32 is compatible (see [Supported Hardware](../getting-started/supported-hardware.md)).
51+
- Refer to [Release Checklist](release-checklist.md) for creating a production release.

‎docs/getting-started/installation.md‎

Lines changed: 52 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -5,81 +5,66 @@ MicroPythonOS can be installed on supported microcontrollers (e.g., ESP32) or de
55
## Installing on ESP32
66

77
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-
```
18-
19-
20-
Build for ESP32:
21-
22-
```bash
23-
cd ~/MicroPythonOS/MicroPythonOS
24-
./scripts/build_lvgl_micropython.sh esp32 prod
25-
```
26-
27-
For a development build (no preinstalled files):
28-
29-
```bash
30-
./scripts/build_lvgl_micropython.sh esp32 dev
31-
```
32-
33-
34-
Flash to ESP32:
35-
36-
- Put your ESP32 in bootloader mode (long-press the BOOT button if running MicroPythonOS).
37-
- Flash the firmware:
38-
39-
```bash
40-
./scripts/flash_over_usb.sh
41-
```
42-
43-
- For a development build, install files manually:
44-
45-
```bash
46-
./scripts/install.sh
47-
```
48-
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+
```
18+
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+
```
28+
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+
```
4939

5040
## Installing on Desktop (Linux/MacOS)
5141

52-
Install Dependencies (Linux):
53-
bash
54-
42+
1. **Install Dependencies** (Linux):
43+
```bash
5544
sudo apt install libv4l-dev # For webcam support
45+
```
46+
See [lvgl-micropython](https://github.com/MicroPythonOS/lvgl-micropython) for additional dependencies.
5647

57-
See lvgl-micropython for additional dependencies.
58-
Build for Desktop:
59-
bash
60-
48+
2. **Build for Desktop**:
49+
```bash
6150
cd ~/MicroPythonOS/MicroPythonOS
6251
./scripts/build_lvgl_micropython.sh unix dev
63-
64-
For MacOS (untested):
65-
bash
66-
52+
```
53+
For MacOS (untested):
54+
```bash
6755
./scripts/build_lvgl_micropython.sh macOS dev
56+
```
6857

69-
Run on Desktop:
70-
71-
Download a release (e.g., MicroPythonOS_amd64_Linux_0.システ0.6) or use your build.
72-
Run:
73-
bash
74-
75-
cd internal_filesystem/
76-
/path/to/MicroPythonOS_amd64_Linux_0.0.6 -X heapsize=32M -v -i -c "$(cat boot_unix.py main.py)"
77-
78-
See scripts/run_on_desktop.sh for options like fullscreen or direct app launch.
79-
80-
Next Steps
81-
82-
Check Supported Hardware (supported-hardware.md) for compatible devices.
83-
Explore Built-in Apps (../apps/built-in-apps.md) to get started with the system.
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)"
64+
```
65+
- See `scripts/run_on_desktop.sh` for options like fullscreen or direct app launch.
8466

67+
## Next Steps
8568

69+
- Check [Supported Hardware](supported-hardware.md) for compatible devices.
70+
- Explore [Built-in Apps](../apps/built-in-apps.md) to get started with the system.

0 commit comments

Comments
 (0)