Skip to content

Commit 5f761fb

Browse files
committed
README: initially document commands
Signed-off-by: Daniel Maslowski <[email protected]>
1 parent 63b0f9d commit 5f761fb

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,19 @@ The [architecture and design](docs/architecture.md) is based on experience.
1313
To test this tool, you will need sample [firmware images](docs/images.md).
1414
For convenience, take a look at the [scripts](scripts/) used for development.
1515

16+
## Commands
17+
18+
### `me`
19+
20+
The `me` command lets you print, edit and check the (CS)ME firmware.
21+
The `me clean` command is compatible with `me_cleaner`, with minor differences:
22+
23+
- The `--whitelist` and `--blacklist` flags do not cause deletion of partitions
24+
when multiple partitions refer to the same range, but at least one of them is
25+
to be retained. This is considered a bug fix.
26+
- The `--check` flag checks _all_ directory partitions as well as the presence
27+
of the FTPR. Analysis details are printed unconditionally.
28+
1629
## Development
1730

1831
To run the CLI via `cargo` directly, remember to add arguments after an extra

0 commit comments

Comments
 (0)