diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f2e95e63a..2d7ae6062 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -61,15 +61,15 @@ jobs: with: path: etc/usr/artifacts/ - # - name: Make temp dir - # run: mkdir -p etc/usr/fw # make temp directory + - name: Copy firmware readme + run: cp -u ${{ github.workspace }}/Firmware/Targets/README_FIRMWARE.md etc/usr/artifacts/README.md # # Move hex files # - name: Move firmware files # run: find etc/usr/artifacts/ -name '*.hex' -exec cp {} etc/usr/fw/ \; - name: Zip firmware - run: zip -qq -r Firmware.zip OpenFFBoard-Firmware-* + run: zip -qq -r Firmware.zip OpenFFBoard-Firmware-* README.md working-directory: etc/usr/artifacts/ - name: Zip configurator diff --git a/Firmware/Targets/README_FIRMWARE.md b/Firmware/Targets/README_FIRMWARE.md new file mode 100644 index 000000000..712f6cdc7 --- /dev/null +++ b/Firmware/Targets/README_FIRMWARE.md @@ -0,0 +1,16 @@ +## Firmware versions + +Use the correct firmware for your board. +Flashing an incorrect firmware can result in a non working device or even damage to the hardware. +If you accidentially flashed an incorrect firmware stay in DFU mode (or use ST-link) and do a clean full erase. + +Use the .hex file for updates. + +The following builds are available: + +* F407VG: Official FFBoard 1.2+ + - Includes all features. Requires VBUS connection +* F407VG_DISCO: Third party development kits (ST F407 Discovery board, different pin mapping) + - See https://github.com/Ultrawipf/OpenFFBoard/wiki/Pinouts-and-peripherals#f407-disco-pinout + - No VBUS required +* F411RE: FFBoard 1.0 (Only supports TMC driver!) \ No newline at end of file