Skip to content

Commit 2dfc5d5

Browse files
update docs
1 parent a4c41d7 commit 2dfc5d5

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

docs/building/desktop.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ MicroPythonOS can be built to run as an application on Linux desktops (fully sup
55
## Prerequisites
66

77
- Install dependencies (Linux):
8-
```bash
8+
```
99
sudo apt install libv4l-dev # For webcam support
1010
```
1111
- See [lvgl-micropython](https://github.com/MicroPythonOS/lvgl_micropython) for additional requirements.
@@ -15,19 +15,19 @@ sudo apt install libv4l-dev # For webcam support
1515

1616
1. **Navigate to the Repository**:
1717

18-
```bash
18+
```
1919
cd ~/MicroPythonOS/MicroPythonOS
2020
```
2121
2222
2. **Build for Linux**:
2323
24-
```bash
24+
```
2525
./scripts/build_lvgl_micropython.sh unix dev
2626
```
2727
2828
3. **Build for MacOS** (untested):
2929
30-
```bash
30+
```
3131
./scripts/build_lvgl_micropython.sh macOS dev
3232
```
3333
@@ -37,7 +37,7 @@ sudo apt install libv4l-dev # For webcam support
3737
2. Run the application:
3838
3939
<pre>
40-
```bash
40+
```
4141
cd internal_filesystem/
4242
/path/to/MicroPythonOS_amd64_Linux -X heapsize=32M -v -i -c "$(cat boot_unix.py main.py)"
4343
```

docs/building/porting.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Ideally, the hardware drivers (for your display) are also already available in t
66

77
Of course, porting is always quite a technical undertaking, so if you want to make your life easy, just purchase one of the already supported devices - they're fairly cheap.
88

9+
If you prefer to have the porting work done for you and you're open to making a donation, be sure to [reach out](mailto:[email protected]) and we'll get it done!
10+
911
## What to write
1012

1113
By design, the only device-specific code for MicroPythonOS is found in the ```internal_filesystem/boot*.py``` files.

docs/building/release-checklist.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Document changes in `CHANGELOG.md`.
1111
- Increment `CURRENT_OS_VERSION` in `internal_filesystem/lib/mpos/info.py`.
1212
- Update version numbers for modified apps:
1313

14-
```bash
14+
```
1515
git diff --stat 0.0.4 internal_filesystem/ # Check changes since last release
1616
git diff 0.0.4 -- internal_filesystem/apps/*/META-INF/* # Check app manifests
1717
git diff 0.0.4 -- internal_filesystem/builtin/apps/*/META-INF/* # Check built-in app manifests
@@ -21,7 +21,7 @@ git diff 0.0.4 -- internal_filesystem/builtin/apps/*/META-INF/* # Check built-i
2121

2222
**Bundle and publish apps**:
2323

24-
```bash
24+
```
2525
./scripts/bundle_apps.sh
2626
pushd ../apps/
2727
git add apps/
@@ -31,7 +31,7 @@ git push
3131

3232
**Build for all supported devices**
3333

34-
```bash
34+
```
3535
./scripts/build_all.sh
3636
```
3737

@@ -44,7 +44,7 @@ git push
4444
**Copy the builds to the [install](https://github.com/MicroPythonOS/install) and [updates](https://github.com/MicroPythonOS/updates) repositories**:
4545

4646
This is a manual action, but check out these old scripts for inspiration:
47-
```bash
47+
```
4848
scripts/release_to_updates.sh
4949
scripts/release_to_install.sh
5050
```

0 commit comments

Comments
 (0)