From c4fe9a72131a11cee2daed4b303898b907261c88 Mon Sep 17 00:00:00 2001
From: xGlc <xglocman@gmail.com>
Date: Sat, 11 Apr 2026 23:31:26 +0200
Subject: [PATCH] docs: add readme

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5e18783
--- /dev/null
+++ b/README.md
@@ -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.