From 48e5f7cf0be32da688bc9b5616c4aed6ab2e156f Mon Sep 17 00:00:00 2001 From: webbrain-one <295484252+webbrain-one@users.noreply.github.com> Date: Thu, 13 Aug 2026 00:44:39 +0300 Subject: [PATCH 1/2] docs: improve README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7492323..86142fb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # microStore Advanced header-only KV store for embedded filesystems that follows the log-structured KV architecture used by systems such as Bitcask, which combines an append-only log with an in-memory index for fast lookups. @@ -28,7 +30,7 @@ Advanced header-only KV store for embedded filesystems that follows the log-stru There is a bug in older versions of `esp_littlefs` that manifests as a crash on ESP32 builds using the default `espressif32` platofrm. A fix is present in more recent versions of the ESP-IDF (5.x), but that version does not (yet) ship with PlatformIO. -Since ESP-IF is provided as a binary for linking, there is no known clean option for overriding the `esp_littlefs` with a patched version. +Since ESP-IDF is provided as a binary for linking, there is no known clean option for overriding the `esp_littlefs` with a patched version. The current workaround for this issue is to use the `pioarduino` fork for Arduino Core 3.x / ESP-IDF 5.x support which contains this fix. This can be enable with the following platform definition in `platformio.ini`: ``` @@ -69,4 +71,4 @@ In particular, contributors are asked to: - Test changes thoroughly, including on **all affected platforms** when modifying shared code. - Update documentation when introducing user-visible changes. -Following these guidelines helps streamline reviews, improve software quality, and make it easier to integrate contributions. \ No newline at end of file +Following these guidelines helps streamline reviews, improve software quality, and make it easier to integrate contributions. From 22b1afdb3aceb8d9bc9232a734aabaa1dd988e7d Mon Sep 17 00:00:00 2001 From: Chad Attermann Date: Tue, 10 Nov 2026 08:38:36 -0700 Subject: [PATCH 2/2] Fix typos in README.md Corrected typos in the README regarding esp_littlefs and platformio.ini. --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 86142fb..1b2492c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ - - # microStore Advanced header-only KV store for embedded filesystems that follows the log-structured KV architecture used by systems such as Bitcask, which combines an append-only log with an in-memory index for fast lookups. @@ -28,10 +26,10 @@ Advanced header-only KV store for embedded filesystems that follows the log-stru ### Bug in esp_littlefs on flash full -There is a bug in older versions of `esp_littlefs` that manifests as a crash on ESP32 builds using the default `espressif32` platofrm. +There is a bug in older versions of `esp_littlefs` that manifests as a crash on ESP32 builds using the default `espressif32` platform. A fix is present in more recent versions of the ESP-IDF (5.x), but that version does not (yet) ship with PlatformIO. Since ESP-IDF is provided as a binary for linking, there is no known clean option for overriding the `esp_littlefs` with a patched version. -The current workaround for this issue is to use the `pioarduino` fork for Arduino Core 3.x / ESP-IDF 5.x support which contains this fix. This can be enable with the following platform definition in `platformio.ini`: +The current workaround for this issue is to use the `pioarduino` fork for Arduino Core 3.x / ESP-IDF 5.x support which contains this fix. This can be enabled with the following platform definition in `platformio.ini`: ``` platform = https://github.com/pioarduino/platform-espressif32/releases/download/51.03.07/platform-espressif32.zip