Cleanup build instructions

Author: ThomasFarstrike

docs/os-development/compiling.md

@@ -1,36 +1,49 @@
-## Compile the code
+## Download the code
+
+Clone the repositories:
+
+```
+git clone --recurse-submodules https://github.com/MicroPythonOS/MicroPythonOS.git
+cd MicroPythonOS/
+```
+
+That will take a while, because it recursively clones MicroPython, LVGL, ESP-IDF and all their dependencies.
+
+#### Optional: updating the code
 
-1. **Make sure you're in the main repository**:
+If you already have an old clone and you want to update it, the easiest is to just delete it and re-clone.
+
+But if you need to save on bandwidth and time, you can instead do the following, which will *throw away all local modifications*:
+
+```
+cd MicroPythonOS/
+git submodule foreach --recursive 'git clean -f; git checkout .'
+git pull --recurse-submodules
+```
+
+## Compile the code
 
-    ```
-    cd MicroPythonOS/
-    ```
+Use the build_mpos.sh script for convenience.
 
-2. **Start the Compilation**
+Usage:
 
-    Usage:
+```
+./scripts/build_mpos.sh <target system>
+```
 
-    <pre>
-    ```
-    ./scripts/build_mpos.sh <target system>
-    ```
-    </pre>
+**Target systems**: `esp32`, `unix` (= Linux) and `macOS`
 
-    **Target systems**: `esp32`, `unix` (= Linux) and `macOS`
-    
-    **Examples**:
+**Examples**:
 
-    <pre>
-    ```
-    ./scripts/build_mpos.sh esp32
-    ./scripts/build_mpos.sh unix
-    ./scripts/build_mpos.sh macOS
-    ```
-    </pre>
+```
+./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:
+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`
+- `lvgl_micropython/build/lvgl_micropy_unix`
+- `lvgl_micropython/build/lvgl_micropy_macOS`
+- `lvgl_micropython/build/lvgl_micropy_ESP32_GENERIC_S3-SPIRAM_OCT-16.bin`
 

docs/os-development/linux.md

@@ -1,20 +1,12 @@
 # OS Development on Linux
 
-Most users can just use a pre-built binary from the [releases page](https://github.com/MicroPythonOS/MicroPythonOS/releases) and install it manually or using the [web installer](https://install.MicroPythonOS.com).
+Most users can simply use a pre-built binary from the [releases page](https://github.com/MicroPythonOS/MicroPythonOS/releases) and install it [manually](installing-on-esp32.md) or using the [web installer](https://install.MicroPythonOS.com).
 
-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!
+But if you want to modify things under the hood, you're in the right place!
 
 ## 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:
+Make sure you have everything installed to compile code:
 
 ```
 sudo apt update

docs/os-development/macos.md

@@ -1,20 +1,12 @@
 # OS Development on MacOS
 
-If you're looking to install MicroPythonOS on a supported device, you can probably just use a pre-built binary from the [releases page](https://github.com/MicroPythonOS/MicroPythonOS/releases) and install it on the device, either manually or with the [web installer](https://install.MicroPythonOS.com).
+Most users can simply use a pre-built binary from the [releases page](https://github.com/MicroPythonOS/MicroPythonOS/releases) and install it [manually](installing-on-esp32.md) or using the [web installer](https://install.MicroPythonOS.com).
 
-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!
+But if you want to modify things under the hood, you're in the right place!
 
 ## 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:
+Make sure you have everything installed to compile code:
 
 ```
 xcode-select --install

docs/os-development/running-on-desktop.md

@@ -15,9 +15,9 @@
 
 2. Make sure you have the software
 
-    If you built from source, then you will already have the software in lvgl_micropython/build/lvgl_micropy_*
+    If you built from source, then you will already have the software in `lvgl_micropython/build/lvgl_micropy_*`
 
-    If you downloaded a pre-built binary (for example /Users/yourname/MicroPythonOS_amd64_MacOS_0.7.1.bin) then put it in the right location now:
+    If you downloaded a pre-built binary (for example `/Users/yourname/MicroPythonOS_amd64_MacOS_0.7.1.bin`) then put it in the right location now:
 
     <pre>
     ```
@@ -38,7 +38,7 @@
 
 ### Notes on MacOS
 
-If you get an error about a missing /opt/homebrew/opt/libffi/lib/libffi.8.dylib then fix that with: `brew install libffi`
+If you get an error about a missing `/opt/homebrew/opt/libffi/lib/libffi.8.dylib` then fix that with: `brew install libffi`
 
 If you get an error about the code being unsigned, then allow it like this: