docs(storage): clarify example READMEs and when to use each

Update storage example docs so FATFS getting_started and wear_levelling
are clearly distinct, refresh the storage index paths, and add
"When to use this example" sections across storage examples.
This commit is contained in:
sonika.rathi
2026-08-25 12:51:01 +02:00
parent ae2088092e
commit 8eade5a911
28 changed files with 221 additions and 51 deletions
+5
View File
@@ -18,6 +18,11 @@ This example demonstrates how to use an SD card with an ESP device. Example does
1. Create a file using `fopen` and write to it using `fprintf`.
1. Rename the file. Before renaming, check if destination file already exists using `stat` function, and remove it using `unlink` function.
1. Open renamed file for reading, read back the line, and print it to the terminal.
## When to use this example
- You have a removable SD/MMC card wired to the SDMMC host and want FATFS access with best throughput (1/4/8-line).
1. __OPTIONAL:__ Format the SD card, check if the file doesn't exist anymore.
This example supports SD (SDSC, SDHC, SDXC) cards and eMMC chips.
+5
View File
@@ -18,6 +18,11 @@ This example demonstrates how to use an SD card with an ESP device over an SPI i
1. Create a file using `fopen` and write to it using `fprintf`.
1. Rename the file. Before renaming, check if destination file already exists using `stat` function, and remove it using `unlink` function.
1. Open renamed file for reading, read back the line, and print it to the terminal.
## When to use this example
- You want to access a removable SD card over the SPI bus, which works on any target and uses flexible GPIOs.
1. __OPTIONAL:__ Format the SD card, check if the file doesn't exist anymore.
This example support SD (SDSC, SDHC, SDXC) cards.