Skip to content

Commit

Permalink
Update README to highlight FLASH_IN_PROJECT
Browse files Browse the repository at this point in the history
  • Loading branch information
BrianPugh committed Oct 26, 2024
1 parent 3e5e7a1 commit 28639dd
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,11 @@ Slight differences between this configuration and SPIFFS's configuration is in t
At compile time, a filesystem image can be created and flashed to the device by adding the following to your project's `CMakeLists.txt` file:

```
littlefs_create_partition_image(partition_name path_to_folder_containing_files)
littlefs_create_partition_image(partition_name path_to_folder_containing_files FLASH_IN_PROJECT)
```

If `FLASH_IN_PROJECT` is not specified, the image will still be generated, but you will have to flash it manually using `esptool.py`, `parttool.py`, or a custom build system target.

For example, if your partition table looks like:

```
Expand All @@ -126,14 +128,13 @@ factory, app, factory, 0x10000, 1M,
graphics, data, spiffs, , 0xF0000,
```

and your project has a folder called `device_graphics`, your call should be:
and your project has a folder called `device_graphics/`, your call should be:

```
littlefs_create_partition_image(graphics device_graphics)
littlefs_create_partition_image(graphics device_graphics FLASH_IN_PROJECT)
```



# Performance

Here are some naive benchmarks to give a vague indicator on performance.
Expand Down

0 comments on commit 28639dd

Please sign in to comment.