From 1d912794c2a8f626f609e2f5b61ce32ef3d07af0 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Wed, 3 Jan 2024 18:10:31 -0600 Subject: [PATCH] docs update for new concatenate JSON feature and flags Signed-off-by: Brian S. Stephan --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1c1e982..792ed62 100644 --- a/README.md +++ b/README.md @@ -53,11 +53,16 @@ A quick demonstration of the editor is available [on asciinema.org](https://asci ### concatenate -`concatenate` combines a GP2040-CE firmware .bin file (such as from a fresh build) and a GP2040-CE board's storage -section .bin or config (with footer) .bin, and produces a properly-offset .bin file suitable for flashing to a board. -This may be useful to ensure the board is flashed with a particular configuration, for instances such as producing a -binary to flash many boards with a particular configuration (specific customizations, etc.), or keeping documented -backups of what you're testing with during development. +`concatenate` combines a GP2040-CE firmware .bin file (such as from a fresh build) with: + +* a GP2040-CE user config, in the form of + * a config section .bin (with footer) (optionally padded) (`--binary-user-config-filename`) or + * a JSON file representing the config (`--json-user-config-filename`) + +...and produces a properly-offset .bin file suitable for flashing to a board. This may be useful to ensure the board is +flashed with a particular configuration, for instances such as producing a binary to flash many boards with a particular +configuration (specific customizations, etc.), or keeping documented backups of what you're testing with during +development. The produced binary can be written to a file with `--new-binary-filename FILENAME` or straight to a RP2040 in BOOTSEL mode with `--usb`. @@ -65,7 +70,8 @@ The produced binary can be written to a file with `--new-binary-filename FILENAM Sample usage: ``` -% concatenate build/GP2040-CE_foo_bar.bin storage-dump.bin --new-binary-filename new-firmware-with-config.bin +% concatenate build/GP2040-CE_foo_bar.bin --binary-user-config-filename storage-dump.bin \ + --new-binary-filename new-firmware-with-config.bin ``` ### dump-config