Skip to content

Commit 17619bb

Browse files
ThomasFarstrikeThomasFarstrike
committed
improve docs
1 parent 7f8867d commit 17619bb

File tree

10 files changed

+49
-60
lines changed

10 files changed

+49
-60
lines changed

‎docs/architecture/system-components.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
MicroPythonOS consists of several core components that initialize and manage the system.
44

5-
- **boot.py**: Initializes hardware on ESP32 microcontrollers.
6-
- **boot_unix.py**: Initializes hardware on Linux desktops (and potentially MacOS).
5+
- **boot.py**: Initializes hardware on the [Waveshare ESP32-S3-Touch-LCD-2](https://www.waveshare.com/wiki/ESP32-S3-Touch-LCD-2)
6+
- **boot_fri3d2024.py**: Initializes hardware on the [Fri3d Camp 2024 Badge](https://fri3d.be/badge/2024/)
7+
- **boot_unix.py**: Initializes hardware on Linux and MacOS systems
8+
79
- **main.py**:
810
- Sets up the user interface.
911
- Provides helper functions for apps.

‎docs/building/index.md‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎docs/getting-started/installation.md‎

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,16 @@
22

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

5-
If you're a developer, you can [build it yourself and install from source](../building/index.md)
6-
75
To simply install prebuilt software, read on!
86

97
## Installing on ESP32
108

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

13-
## Installing on Desktop (Linux/MacOS)
14-
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:
20-
21-
```
22-
git clone https://github.com/MicroPythonOS/MicroPythonOS.git
23-
cd MicroPythonOS/
24-
cd internal_filesystem/
25-
```
26-
27-
Now run it by starting the entry points, boot_unix.py and main.py:
28-
29-
```
30-
/tmp/MicroPythonOS_amd64_Linux_0.0.8 -X heapsize=32M -v -i -c "$(cat boot_unix.py main.py)"
31-
```
11+
For advanced usage, such as installing development builds without any files, see [Installing on ESP32](../os-development/installing-on-esp32.md).
3212

33-
You can also check out `scripts/run_desktop.sh` for more examples, such as immediately starting an app or starting fullscreen.
13+
{!os-development/running-on-desktop.md!}
3414

3515
## Next Steps
3616

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

‎docs/getting-started/supported-hardware.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,12 @@ MicroPythonOS runs on a variety of platforms, from microcontrollers to desktops.
1010
## Desktop Computers
1111

1212
- **Linux**: Supported using SDL for display handling.
13-
- **MacOS**: Should work but untested.
13+
- **MacOS**: Supported as well.
1414

1515
## Raspberry Pi
1616

17-
- **Raspbian/Linux-based**: Should work, especially with a Linux desktop. Untested.
17+
- **Raspbian and other Linux-based**: Should work!
1818

1919
## Notes
2020

21-
- Ensure your hardware supports touch screens, IMUs, or cameras for full feature compatibility.
2221
- Check [Installation](installation.md) for setup instructions.

‎docs/os-development/compile-and-run.md‎ renamed to ‎docs/os-development/compiling.md‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,3 @@
4444
- lvgl_micropython/build/lvgl_micropy_macOS
4545
- lvgl_micropython/build/lvgl_micropy_ESP32_GENERIC_S3-SPIRAM_OCT-16.bin
4646
47-
## Running on Linux or MacOS
48-
49-
1. Download a release binary (e.g., `MicroPythonOS_amd64_Linux`, `MicroPythonOS_amd64_MacOS`) or build your own [on MacOS](macos.md) or [Linux](linux.md).
50-
2. Run the application:
51-
52-
<pre>
53-
```
54-
cd internal_filesystem/ # make sure you're in the right place to find the filesystem
55-
/path/to/release_binary -X heapsize=32M -v -i -c "$(cat boot_unix.py main.py)"
56-
```
57-
</pre>
58-
59-
There's also a convenient `./scripts/run_desktop.sh` script that will attempt to start the latest build that you compiled yourself.
60-
61-
### Modifying files
62-
63-
You'll notice that, whenever you change a file on your local system, the changes are immediately visible whenever you reload the file.
64-
65-
This results in a very quick coding cycle.
66-
67-
Give this a try by editing `internal_filesystem/builtin/apps/com.micropythonos.about/assets/about.py` and then restarting the "About" app. Powerful stuff!

‎docs/os-development/index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# OS Development
2+
3+
Most users will just want to run MicroPythonOS and built apps for it.
4+
5+
But if you want to work on stuff that's "under the hood", then choose one of the entries under "OS Development" in the menu.

‎docs/os-development/linux.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,6 @@ sudo apt-get install -y build-essential libffi-dev pkg-config cmake ninja-build
2323

2424

2525

26-
{!os-development/compile-and-run.md!}
26+
{!os-development/compiling.md!}
27+
28+
{!os-development/running-on-desktop.md!}

‎docs/os-development/macos.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ xcode-select --install || true # already installed on github
2121
brew install pkg-config libffi ninja make SDL2
2222
```
2323

24+
{!os-development/compiling.md!}
2425

25-
{!os-development/compile-and-run.md!}
26+
{!os-development/running-on-desktop.md!}

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Running on Linux or MacOS
2+
3+
1. Download a release binary (e.g., `MicroPythonOS_amd64_Linux`, `MicroPythonOS_amd64_MacOS`) or build your own [on MacOS](macos.md) or [Linux](linux.md).
4+
5+
2. If you don't have a local clone yet then do it now, so you have the local_filesystem/ folder:
6+
7+
<pre>
8+
```
9+
git clone https://github.com/MicroPythonOS/MicroPythonOS.git
10+
cd MicroPythonOS/
11+
```
12+
</pre>
13+
14+
3. Start it:
15+
16+
<pre>
17+
```
18+
cd internal_filesystem/ # make sure you're in the right place to find the filesystem
19+
/path/to/release_binary -X heapsize=32M -v -i -c "$(cat boot_unix.py main.py)"
20+
```
21+
</pre>
22+
23+
There's also a convenient `./scripts/run_desktop.sh` script that will attempt to start the latest build that you compiled yourself.
24+
25+
### Modifying files
26+
27+
You'll notice that, whenever you change a file on your local system, the changes are immediately visible whenever you reload the file.
28+
29+
This results in a very quick coding cycle.
30+
31+
Give this a try by editing `internal_filesystem/builtin/apps/com.micropythonos.about/assets/about.py` and then restarting the "About" app. Powerful stuff!

‎docs/overview.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,3 @@ Explore MicroPythonOS in action:
4848
<figcaption>WiFi Settings</figcaption>
4949
</figure>
5050
</div>
51-
52-
[See more screenshots](#screenshots)

0 commit comments

Comments
 (0)