You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/architecture/filesystem.md
+13-2Lines changed: 13 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,8 @@ MicroPythonOS uses a structured filesystem to organize apps, data, and resources
8
8
-**builtin/**: Read-only filesystem compiled into the OS, mounted at boot by `main.py`.
9
9
-**apps/**: See [Built-in Apps](../apps/built-in-apps.md).
10
10
-**res/**: Resources (icons, fonts, etc.).
11
-
-**cache/**: Temporary files for each app. Deleted when the app is uninstalled, and may also be deleted without uninstalling the app to free up space.
11
+
-**cache/**: Temporary files for each app. Deleted when the app is uninstalled, but may also be deleted to free up space when the filesystem is almost full, without the app being uninstalled.
12
+
-**org.yourdomain.yourapp/**: Files cached by the `org.yourdomain.yourapp` app, such as large audio files or images that are nice to cache, but can be re-downloaded if needed.
12
13
-**data/**: Content files independent of specific apps (images, audio, recordings, etc.). Used by apps like Camera, ImageView, Sound Recorder, and Music Player.
13
14
-**lib/**: Libraries and frameworks
14
15
-**mpos/**: MicroPythonOS libraries and frameworks
@@ -17,7 +18,17 @@ MicroPythonOS uses a structured filesystem to organize apps, data, and resources
-**com.micropythonos.settings/**: Storage used by the built-in Settings App
19
20
-**com_micropythonos_nostr/**: Storage for the Nostr App
21
+
-**sdcard/**: Mount point for an optional (micro) SD card that may be inserted.
20
22
21
23
This structure ensures a clear separation between system resources, apps, and user data.
22
24
23
-
When creating packages, use `_` instead of `.` in names (e.g., `com_micropythonos_nostr`), since `.` has special meaning in Python module imports.
25
+
**Note**: When creating packages, use `_` instead of `.` in names (e.g., `com_micropythonos_nostr`), since `.` has special meaning in Python module imports.
26
+
27
+
## External storage layout
28
+
29
+
A similar structure should be used on additional storage devices, such as a micro SD card.
30
+
31
+
For example, **sdcard/cache/org.yourdomain.yourapp** should be used to cache files which may similarly be deleted to free up space when the filesystem is almost full.
32
+
33
+
Currently, **sdcard/apps** is not yet used to search for and install apps but it's likely that it will be, in a future release.
0 commit comments