From e8b72561b2755280697c3fd4167f87de2e3cad71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kuba=20Szczodrzy=C5=84ski?= Date: Sun, 24 Apr 2022 13:46:49 +0200 Subject: [PATCH] [core] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 0bcaac1..cff6429 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ PlatformIO development platform for IoT modules manufactured by Tuya Inc. +The main goal of this project is to provide a usable build environment for IoT developers. While also providing vendor SDKs as PlatformIO cores, +the project focuses on developing working Arduino-compatible cores for supported platforms. The cores are inspired by Espressif's official core for ESP32, +which should make it easier to port/run existing ESP apps on Tuya IoT (and 3-rd party) platforms. + +LibreTuya also provides a common interface for all platform implementations. The interface is based on ESP32 official libraries. + **Note:** this project is work-in-progress. ## Board List @@ -71,6 +77,8 @@ arduino/ ├─ / Arduino Core for specific platform │ ├─ cores/ Core files │ ├─ libraries/ Supported built-in libraries +├─ libretuya-api/ +│ ├─ / Library interfaces (.h) for LibreTuya Arduino cores boards/ ├─ / Board-specific code │ ├─ variant.cpp Arduino variant initialization