Skip to content

docs: improve README #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: improve README #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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`:

```
Expand Down Expand Up @@ -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.
Following these guidelines helps streamline reviews, improve software quality, and make it easier to integrate contributions.