Skip to content

Commit dc2c808

Browse files
committed
Minor updates to README.md and main.py.
Improved wording and formatting in README.md.
1 parent 993f5bb commit dc2c808

File tree

3 files changed

+13
-12
lines changed

3 files changed

+13
-12
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -138,14 +138,15 @@ operations on attached esp32 devices:
138138

139139
### Install from PYPI
140140

141+
- Using uv: `uv tool install mp-image-tool-esp32`,
141142
- Using pip: `pip install mp-image-tool-esp32`, or
142-
- Using uv: `uv tool install mp-image-tool-esp32`.
143+
- Using pipx: `pipx install mp-image-tool-esp32`.
143144

144-
Support for the `fs` command (reading, checking and copying files to/from
145-
littlefs filesystems on your device), requires selecting the `littlefs` extra
146-
eg: `pip install mp-image-tool-esp32[littlefs]`. This has been made available as
147-
an extra because installing the `littlefs-python` package requires extra build
148-
tools on your computer, which you may avoid if you don't need filesystem access.
145+
Sinve version `v0.0.14`, support for the `fs` command (reading, checking and
146+
copying files to/from littlefs filesystems on your device), requires selecting
147+
the `littlefs` extra eg: `uv tool install mp-image-tool-esp32[littlefs]`.
148+
`littlefs` support has been made available as an extra, which you may avoid if
149+
you don't need filesystem access.
149150

150151
### Install from github source
151152

@@ -156,7 +157,7 @@ dependencies and dev environments.
156157
git clone https://github.com/glenn20/mp-image-tool-esp32
157158
cd mp-image-tool-esp32
158159
uv build # To build an installable .whl file
159-
uv tool install dist/mp_image_tool_esp32-0.0.12-py3-none-any.whl
160+
uv tool install dist/mp_image_tool_esp32-0.0.14-py3-none-any.whl
160161
```
161162

162163
To run the tests: `uv run pytest` or `uv run tox`.

src/mp_image_tool_esp32/firmware_fileio.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ def __enter__(self) -> FirmwareDeviceIO:
140140

141141
def read(self, size: int | None = None) -> bytes:
142142
size = size if size is not None else self._end - self._pos
143-
log.debug(f"Reading {size:#x} bytes from {self._pos:#x}...")
143+
log.debug(f"Reading {size:#x} bytes from offset {self._pos:#x}...")
144144
data = self.esptool.read_flash(self._pos, size)
145145
if len(data) != size:
146146
raise ValueError(f"Read {len(data)} bytes from device, expected {size}.")

src/mp_image_tool_esp32/main.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,15 +124,15 @@ class TypedNamespace(argparse.Namespace):
124124
"--table default" (default (non-OTA) partition table),\
125125
"--table nvs=7B,factory=2M,vfs=0". \
126126
SUBTYPE is optional in most cases (inferred from name).
127-
--delete NAME1[,NAME2] | delete the named partitions
127+
--delete NAME1[,NAME2,...] | delete the named partitions
128128
--add NAME1:SUBTYPE:OFFSET:SIZE[,NAME2,...] \
129129
| add new partitions to table
130-
--resize NAME1=SIZE1[,NAME2=SIZE2] \
130+
--resize NAME1=SIZE1[,NAME2=SIZE2,...] \
131131
| resize partitions \
132132
eg. --resize factory=2M,nvs=5B,vfs=0. \
133133
If SIZE is 0, expand partition to available space
134-
--erase NAME1[,NAME2] | erase the named partitions
135-
--erase-fs NAME1[,NAME2] \
134+
--erase NAME1[,NAME2,...] | erase the named partitions
135+
--erase-fs NAME1[,NAME2,...] \
136136
| erase first 4 blocks of a partition on flash storage.\
137137
Micropython will initialise filesystem on next boot.
138138
--read NAME1=FILE1[,NAME2=FILE2,bootloader=FILE,...] \

0 commit comments

Comments
 (0)