Merge pull request #8 from pennam/docs

Update docs

Author: facchinm

README.md

@@ -0,0 +1,42 @@
+# Arduino UNO R4 WiFi USB Bridge firmware
+
+This firmware uses [arduino-esp32](https://github.com/espressif/arduino-esp32/releases/tag/2.0.9)
+
+## Building
+
+```
+./compile.sh
+```
+Running the compile script will:
+
+1. Download the [arduino-esp32 v2.0.9 core](https://github.com/espressif/arduino-esp32/releases/tag/2.0.9) and build tools
+2. Apply needed [patches](core_esp32.patch)
+3. Compile the firmware using arduino-cli
+4. Export binaries in the build directory inside the `UNOR4USBBridge` folder 
+
+The `compile.sh` script will produce a bunch of binary files that can be flashed using [esptool](https://github.com/espressif/esptool/releases) from the build directory:
+
+```
+esptool --chip esp32s3 --port "/dev/ttyACM0" --baud 921600  --before default_reset --after hard_reset write_flash  -z --flash_mode dio --flash_freq 80m --flash_size 4MB 0x0 "UNOR4USBBridge.ino.bootloader.bin" 0x8000 "UNOR4USBBridge.ino.partitions.bin" 0xe000 "../../../boot/boot_app0.bin" 0x10000 "UNOR4USBBridge.ino.bin"
+```
+
+## Packaging
+
+```
+./export.sh
+```
+
+The `export.sh` script will take care of generating a single binary blob including the TLS certificates bundle. Running the export script will:
+
+1. Invoke the `compile.sh` script
+2. Generate the certificate bundle using this [script](certificates/gen_crt_bundle.py) and this [certificates list](certificates/certificates.pem)
+3. Combine everything in a single binary blob that can be flashed from address 0x0 using [espflash](https://github.com/esp-rs/espflash/releases)
+
+```
+espflash write-bin -b 115200 0x0 S3.bin
+```
+
+## Flashing
+
+To flash the firmware the board needs to be in `ESP download` mode. This can be done [manually](unor4wifi-updater#option-2) or using the [unor4wifi-updater](unor4wifi-updater) script.
+

unor4wifi-updater/README.md

@@ -1,3 +1,11 @@
+# UNO R4 WiFi updater script
+
+This updater script can be used to automatically put the UNO R4 WiFi in `ESP download` mode and upload the latest firmware.
+
+The script uses [unor4wifi-reboot](unor4wifi-reboot) to put the board in `ESP download` mode through an HID message; and [espflash](https://github.com/esp-rs/espflash/releases) to flash the firmware bundle.
+
+# How to use the script
+
 ## On Windows
 * Extract the zip file
 * Disconnect all USB gadgets from your PC
@@ -45,13 +53,13 @@ Running the script from the terminal instead of double click should avoid the co
 
 ![image](https://github.com/pennam/UnoR4WiFiUpdate/assets/20436476/dd776469-ba93-4430-9b72-25a6ca75840f)
 
-## Troubleshooting
+# Troubleshooting
 * If the script report this error: `Cannot put the board in ESP mode. (via 'unor4wifi-reboot')`
 
-### Option 1
+## Option 1
 Disconnect and connect again your UNO R4 WiFi from your PC and re-run the script.
 
-### Option 2
+## Option 2
 Manually put  the UNO R4 WiFi in ESP mode
 
 1. Disconnect the UNO R4 WiFi from your PC