docs: add readme

This commit is contained in:
xGlc
2026-04-11 23:31:26 +02:00
parent d4a9b6663a
commit c4fe9a7213

14
README.md Normal file
View File

@@ -0,0 +1,14 @@
# PPAP Test MicroPython
This is a preparatory test project for the PPAP (PPAP is a plotter) project testing capabilities of MicroPython on ESP32.
## Installation
1. Install [MicroPython](https://micropython.org/download/esp32/) on your ESP32 device.
2. Create venv and install mpremote and micropython-esp32-stub on your host so you get autocomplete.
3. Copy all fiels to your device using mpremote `mpremote cp <local_path> :<remote_path>`.
## Uploading changes
1. Make sure your device is connected.
2. Copy changed files onto a device using mpremote `mpremote cp <local_path> :<remote_path>`.
3. Restart your device `mpremote reset`
4. Check the results on the device.