Skip to content

Commit 428f9e8

Browse files
update
1 parent 507eb19 commit 428f9e8

File tree

3 files changed

+24
-9
lines changed

3 files changed

+24
-9
lines changed

docs/apps/developing-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ In `MANIFEST.JSON`, put:
7070

7171
## Icon
7272

73-
The icon is a simple 64x64 pixel PNG image, which you can create with any tool, such as GIMP.
73+
The icon is a [simple 64x64 pixel PNG image](https://github.com/MicroPythonOS/MicroPythonOS/blob/main/internal_filesystem/builtin/apps/com.micropythonos.launcher/res/mipmap-mdpi/icon_64x64.png), which you can create with any tool, such as GIMP.
7474

7575
It's recommended to keep it as small as possible by setting compression level to 9 and not storing any metadata such as background color, resolution, creation time, comments, Exif data, XMP data, thumbnail or color profile.
7676

docs/architecture/filesystem.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,17 @@
33
MicroPythonOS uses a structured filesystem to organize apps, data, and resources.
44

55
- **/apps/**: Directory for downloaded and installed apps.
6-
- **/apps/com.micropythonos.helloworld/**: Installation directory for HelloWorld App. See [Developing Apps](../apps/developing-apps.md).
6+
- **com.micropythonos.helloworld/**: Installation directory for HelloWorld App. See [Developing Apps](../apps/developing-apps.md).
77
- **/builtin/**: Read-only filesystem compiled into the OS, mounted at boot by `main.py`.
8-
- **/builtin/apps/**: See [Built-in Apps](../apps/built-in-apps.md).
9-
- **/builtin/res/mipmap-mdpi/default_icon_64x64.bin**: Default icon for apps without one.
8+
- **apps/**: See [Built-in Apps](../apps/built-in-apps.md).
9+
- **res/mipmap-mdpi/default_icon_64x64.png**: Default icon for apps without one.
10+
- **lib/**: Libraries and frameworks
11+
- **mpos/**: MicroPythonOS libraries and frameworks
12+
- **ui/**: MicroPythonOS User Interface libraries and frameworks
1013
- **/data/**: Storage for app data.
11-
- **/data/images/**: Images stored by apps (e.g., camera app).
12-
- **/data/com.example.app1/**: App-specific storage (e.g., `config.json`) for com.example.app1.
14+
- **com.micropythonos.helloworld/**: App-specific storage (e.g., `config.json`)
15+
- **com.micropythonos.settings/**: Storage used by the built-in Settings App
16+
- **com.micropythonos.wifi/**: Storage used by the built-in WiFi App
17+
- **images/**: Generic storage for images (use by e.g. the Camera App).
1318

1419
This structure ensures a clear separation between system resources, apps, and user data.

docs/architecture/system-components.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,18 @@ MicroPythonOS consists of several core components that initialize and manage the
55
- **boot.py**: Initializes hardware on ESP32 microcontrollers.
66
- **boot_unix.py**: Initializes hardware on Linux desktops (and potentially MacOS).
77
- **main.py**:
8-
- Sets up the user interface.
9-
- Provides helper functions for apps.
10-
- Launches the `launcher` app to start the system.
8+
- Sets up the user interface.
9+
- Provides helper functions for apps.
10+
- Launches the `launcher` app to start the system.
1111

1212
These components work together to bootstrap the OS and provide a foundation for apps. See [Filesystem Layout](filesystem.md) for where apps and data are stored.
13+
14+
Additionally, the following concepts are also used throughout the code:
15+
16+
- **Activity**
17+
- **ActivityNavigator**
18+
- **Intent**
19+
- **SharedPreferences**
20+
- **WidgetAnimator**
21+
- **WiFiService**
22+

0 commit comments

Comments
 (0)