feat: initial

README.md

@@ -1,2 +1,21 @@
-# esp_firmware_template
+# Universal Optical 2-Channel Angle Gauge / Tachometer
 
+## Tested on
+
+1. [ESP32 ESP-IDF v5.5.3](https://docs.espressif.com/projects/esp-idf/en/v5.5.3/esp32/index.html)
+
+## SAST Tools
+
+[PVS-Studio](https://pvs-studio.com/pvs-studio/?utm_source=website&utm_medium=github&utm_campaign=open_source) - static analyzer for C, C++, C#, and Java code.
+
+## Build and flash
+
+Run the following command to firmware build and flash module:
+
+```text
+cd your_projects_folder
+git clone --recurse-submodules https://github.com/aZholtikov/ate0005
+cd ate0005
+idf.py build
+idf.py flash
+```