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/apps/creating-apps.md
+14-8Lines changed: 14 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,22 @@ More advanced examples are available in the [source code repository](https://git
8
8
9
9
## Structure
10
10
11
-
Create the following file and folder structure:
11
+
Create a git repo with the following file and folder structure:
12
12
13
13
```
14
-
com.micropythonos.helloworld/
14
+
.gitignore
15
+
CHANGELOG.md
16
+
LICENSE
17
+
README.md
18
+
com.yourdomain.appname/
15
19
├── MANIFEST.JSON
16
20
├── icon_64x64.png
17
21
└── hello.py
18
22
```
19
23
20
-
This flat layout puts the required `MANIFEST.JSON` and app icon at the top level, alongside your Python files. Subfolders are still allowed if you want to organize larger apps, but **each directory costs about 8 KiB of storage in LittleFS**, so use them sparingly on device.
24
+
The `com.yourdomain.appname/` folder and everything in it is the actual app that will be installed. All the rest is support materials, tests, info, etc.
25
+
26
+
For most apps, this relatively flat layout with the required `MANIFEST.JSON` and app icon alongside the Python files, is recommended. Subfolders are allowed if you want to organize larger apps, but **each directory costs about 8 KiB of storage in LittleFS**, so use them sparingly.
21
27
22
28
## App code
23
29
@@ -49,7 +55,7 @@ In `MANIFEST.JSON`, put:
49
55
"publisher": "MicroPythonOS",
50
56
"short_description": "Minimal app",
51
57
"long_description": "Demonstrates the simplest app.",
52
-
"fullname": "com.micropythonos.helloworld",
58
+
"fullname": "com.yourdomain.appname",
53
59
"version": "0.0.2",
54
60
"categories": ["Development"],
55
61
"activities": [
@@ -164,11 +170,11 @@ The size will probably be somewhere between 3 and 10KB.
164
170
165
171
## Installing the App
166
172
167
-
The app can be installed by copying the top-level folder `com.micropythonos.helloworld/` (and its contents) to the `/apps/` folder.
173
+
The app can be installed by copying the top-level folder `com.yourdomain.appname/` (and its contents) to the `/apps/` folder.
168
174
169
175
### On Desktop
170
176
171
-
If you are [running MicroPythonOS on desktop](../os-development/running-on-desktop.md) from a source checkout, copy or move the top-level folder `com.micropythonos.helloworld/` (and its contents) to `internal_filesystem/apps/` and you're good to go.
177
+
If you are [running MicroPythonOS on desktop](../os-development/running-on-desktop.md) from a source checkout, copy or move the top-level folder `com.yourdomain.appname/` (and its contents) to `internal_filesystem/apps/` and you're good to go.
172
178
173
179
### On ESP32
174
180
@@ -180,7 +186,7 @@ Then connect your device with a cable and install your app using:
Take a look at [`scripts/install.sh`](https://github.com/MicroPythonOS/MicroPythonOS/blob/main/scripts/install.sh) for convenient "install everything" or "install one app" scripting.
@@ -195,7 +201,7 @@ You can also launch it manually by typing this in the MicroPython REPL:
0 commit comments