From f5d2cfef156704a4870e49a6e5eff53c1321cefe Mon Sep 17 00:00:00 2001 From: Michael Cardell Widerkrantz Date: Thu, 22 May 2025 16:52:04 +0200 Subject: [PATCH] doc: Mention the tkeyimage tool in firmware README --- hw/application_fpga/fw/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/hw/application_fpga/fw/README.md b/hw/application_fpga/fw/README.md index 72d9524..9f5771a 100644 --- a/hw/application_fpga/fw/README.md +++ b/hw/application_fpga/fw/README.md @@ -737,6 +737,9 @@ functions. Note that these functions are only usable in QEMU and that you might need to `make clean` before building, if you have already built before. +To build a flash image file suitable for use with qemu, use the +`tools/tkeyimage` program. See its documentation. + If you want debug prints to show up on the special TKey HID debug endpoint instead, define `-DTKEY_DEBUG`. This might mean you can't fit the firmware in the ROM space available, however. You will get a