Update docs

Author: ThomasFarstrike

docs/building/esp32.md

@@ -6,16 +6,17 @@ Build MicroPythonOS for ESP32 microcontrollers, such as [supported hardware](../
 
 Clone the required repositories:
 
-```bash
+```
 mkdir ~/MicroPythonOS
 cd ~/MicroPythonOS
 
 git clone https://github.com/MicroPythonOS/MicroPythonOS.git
 git clone https://github.com/MicroPythonOS/freezeFS
 git clone https://github.com/MicroPythonOS/secp256k1-embedded-ecdh
 git clone https://github.com/MicroPythonOS/lvgl_micropython
+
 echo "  espressif/esp32-camera:
-    git: https://github.com/cnadler86/esp32-camera.git" > lvgl_micropython/lib/micropython/ports/esp32/main/idf_component.yml
+    git: https://github.com/MicroPythonOS/esp32-camera" >> lvgl_micropython/lib/micropython/ports/esp32/main/idf_component.yml
 
 git clone https://github.com/cnadler86/micropython-camera-API
 pushd micropython-camera-API/
@@ -26,29 +27,33 @@ popd
 
 ## Build Process
 
-1. **Navigate to the Repository**:
+1. **Navigate to the main repository**:
 
     ```
     cd ~/MicroPythonOS/MicroPythonOS
     ```
 
 2. **Build for Production** (includes preinstalled files):
 
-    ```bash
+    ```
     ./scripts/build_lvgl_micropython.sh esp32 prod waveshare-esp32-s3-touch-lcd-2
     ```
 
     or, depending on the device you're building for:
 
-    ```bash
+    ```
     ./scripts/build_lvgl_micropython.sh esp32 prod fri3d-2024
     ```
 
-3. **Build for Development** (no preinstalled files):
+3. **Build for Development** (no preinstalled/frozen files):
 
-    ```bash
+    ```
     ./scripts/build_lvgl_micropython.sh esp32 dev fri3d-2024
-    # or
+    ```
+
+    or, depending on the device you're building for:
+
+    ```
     ./scripts/build_lvgl_micropython.sh esp32 dev waveshare-esp32-s3-touch-lcd-2
     ```
 
@@ -58,17 +63,18 @@ popd
 
 2. Flash the firmware:
 
-    ```bash
+    ```
     ./scripts/flash_over_usb.sh
     ```
 
-3. For a development build, fill the filesystem manually:
+3. For a development build, fill the filesystem with files manually:
 
-    ```bash
+    ```
     ./scripts/install.sh
     ```
 
 ## Notes
 
+- A "dev" build without frozen files is quite a bit slower when starting apps because all the libraries need to be compiled at runtime.
 - Ensure your ESP32 is compatible (see [Supported Hardware](../getting-started/supported-hardware.md)).
 - Refer to [Release Checklist](release-checklist.md) for creating a production release.

docs/building/release-checklist.md

@@ -2,42 +2,54 @@
 
 Follow these steps to create a new release of MicroPythonOS.
 
-1. **Update Version Numbers**:
+**Update Changelog**:
+
+Document changes in `CHANGELOG.md`.
+
+**Update Version Numbers**:
+
    - Increment `CURRENT_OS_VERSION` in `internal_filesystem/lib/mpos/info.py`.
    - Update version numbers for modified apps:
-     ```bash
-     git diff --stat 0.0.4 internal_filesystem/  # Check changes since last release
-     git diff 0.0.4 -- internal_filesystem/apps/*/META-INF/*  # Check app manifests
-     git diff 0.0.4 -- internal_filesystem/builtin/apps/*/META-INF/*  # Check built-in app manifests
-     ```
-
-2. **Update Changelog**:
-   - Document changes in `CHANGELOG`.
-
-3. **Commit and Tag**:
-   - Commit all changes.
-   - Tag the main repository and external repositories (e.g., LightningPiggy):
-     ```bash
-     git tag -a vX.Y.Z -m "Release vX.Y.Z"
-     git push --tags
-     ```
-
-4. **Build and Release**:
-   - Bundle apps:
-     ```bash
-     ./scripts/bundle_apps.sh
-     ```
-   - Build for production:
-     ```bash
-     ./scripts/build_lvgl_micropython.sh esp32 prod
-     ```
-   - Release to update and install servers:
-     ```bash
-     ./scripts/release_to_updates.sh
-     ./scripts/release_to_install.sh
-     ```
+
+```bash
+git diff --stat 0.0.4 internal_filesystem/  # Check changes since last release
+git diff 0.0.4 -- internal_filesystem/apps/*/META-INF/*  # Check app manifests
+git diff 0.0.4 -- internal_filesystem/builtin/apps/*/META-INF/*  # Check built-in app manifests
+```
+
+**Commit and push** all changes, also in external repositories (e.g., [LightningPiggy](https://github.com/LightningPiggy/LightningPiggyApp)):
+
+**Bundle and publish apps**:
+
+```bash
+./scripts/bundle_apps.sh
+pushd ../apps/
+git add apps/
+git commit -a
+git push
+```
+
+**Build for all supported devices**
+
+```bash
+./scripts/build_all.sh
+```
+
+**Release to GitHub**
+
+- Upload ``` ../build_outputs/ ``` to a [new GitHub release](https://github.com/MicroPythonOS/MicroPythonOS/releases/new)
+- Add the CHANGELOG.md
+- Tag the code with the new release
+
+**Copy the builds to the [install](https://github.com/MicroPythonOS/install) and [updates](https://github.com/MicroPythonOS/updates) repositories**:
+
+This is a manual action, but check out these old scripts for inspiration:
+```bash
+scripts/release_to_updates.sh
+scripts/release_to_install.sh
+```
 
 ## Notes
 
-- Ensure all repositories are synchronized before tagging.
+- Ensure all repositories are pushed before tagging.
 - Verify builds on target hardware (see [Building for ESP32](esp32.md)).

docs/getting-started/supported-hardware.md

@@ -4,8 +4,8 @@ MicroPythonOS runs on a variety of platforms, from microcontrollers to desktops.
 
 ## ESP32 Microcontrollers
 
-- [Fri3d Camp 2024 Badge](https://fri3d.be/badge/2024/)
 - [Waveshare ESP32-S3-Touch-LCD-2](https://www.waveshare.com/wiki/ESP32-S3-Touch-LCD-2): Fully Supported
+- [Fri3d Camp 2024 Badge](https://fri3d.be/badge/2024/): Good support but missing a bit of hardware support (IMU, Buzzer, Multi-Color LEDs, Communicator Add-On)
 
 ## Desktop Computers