OS Development on MacOS

Most users can just use a pre-built binary from the releases page and install it manually or using the web installer.

But if for some reason that one doesn't work, or you really want to modify things under the hood, you're in the right place here!

Get the prerequisites

Clone the repositories:

git clone --recurse-submodules https://github.com/MicroPythonOS/MicroPythonOS.git

That will take a while, because it recursively clones MicroPython, LVGL, ESP-IDF and all their dependencies.

While that's going on, make sure you have everything installed to compile code:

xcode-select --install
brew install pkg-config libffi ninja make SDL2

Compile the code

Make sure you're in the main repository:

cd MicroPythonOS/
Start the Compilation

Usage:
```
./scripts/build_mpos.sh <target system>
```
Target systems: esp32, unix (= Linux) and macOS

Examples:
```
./scripts/build_mpos.sh esp32
./scripts/build_mpos.sh unix
./scripts/build_mpos.sh macOS
```
The resulting build file will be in lvgl_micropython/build/, for example:
- lvgl_micropython/build/lvgl_micropy_unix
- lvgl_micropython/build/lvgl_micropy_macOS
- lvgl_micropython/build/lvgl_micropy_ESP32_GENERIC_S3-SPIRAM_OCT-16.bin

Running on Linux or MacOS

Make sure you have the software

Either you built your own on MacOS or Linux or you can download a pre-built executable binary (e.g., MicroPythonOS_amd64_Linux, MicroPythonOS_amd64_MacOS) from the releases page.

Give it executable permissions:

chmod +x /path/to/MicroPythonOS_executable_binary
Make sure you have the local_filesystem/ folder

You probably already have a local clone that contains the internal_filesystem.

If not, then clone it now:
```
git clone --recurse-submodules https://github.com/MicroPythonOS/MicroPythonOS.git
cd MicroPythonOS/
```

Start it from the local_filesystem/ folder:

cd internal_filesystem/ # make sure you're in the right place to find the filesystem
/path/to/MicroPythonOS_executable_binary -X heapsize=32M -v -i -c "$(cat boot_unix.py main.py)"

There's also a convenient ./scripts/run_desktop.sh script that will attempt to start the latest build that you compiled yourself.

Modifying files

You'll notice that, whenever you change a file on your local system, the changes are immediately visible whenever you reload the file.

This results in a very quick coding cycle.

Give this a try by editing internal_filesystem/builtin/apps/com.micropythonos.about/assets/about.py and then restarting the "About" app. Powerful stuff!