From 231b349909712726f92435a01a7987ce9f8aceea Mon Sep 17 00:00:00 2001 From: rusefillc <48498823+rusefillc@users.noreply.github.com> Date: Sun, 22 May 2022 20:30:09 -0400 Subject: [PATCH] Update readme.md --- firmware/config/boards/readme.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/firmware/config/boards/readme.md b/firmware/config/boards/readme.md index ff7f779958..49fa949fcf 100644 --- a/firmware/config/boards/readme.md +++ b/firmware/config/boards/readme.md @@ -1,5 +1,10 @@ # Boards Directory +rusEFI supports quite a wide array of hardware - we support stm32f4 and we support stm32h7, we have [kinetis](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/k-series-cortex-m4:KINETIS_K_SERIES) and we support cypress MCUs. We support on-board a number of smart GPIO chips, overall we support quite a wide array of hardware. With all those options our goal is to provide nice _user_ experience which means upfront investment by _board designer_. + +For best user experience we have more than a dozen of different _binaries_ which are all compiled from same _firmware_ files with different configuration. This folder is all about that process. + + See [misc/jenkins/compile_other_versions/run.bat](misc/jenkins/compile_other_versions/run.bat) which is executed by build server. @@ -11,11 +16,13 @@ One BOARD_NAME could be producing a number of artifacts via compile_$BUNDLE_NAME Work in progress: SHORT_BOARDNAME becomes BUNDLE_NAME -New board procedure +New board procedure once you have new folder in this *boards* directory -1) manually add one signature*.h and one .ini files into git - see gen_config.sh comment +1) update [gen_config.sh](https://github.com/rusefi/rusefi/blob/master/firmware/gen_config.sh): add "board board" pair into 'for BOARD' iteration - this would produce new signature*.h file and new rusefi*.ini file -2) update gen_config.sh: add "board board" pair into 'for BOARD' iteration +2) update [build-firmware.yaml](https://github.com/rusefi/rusefi/blob/master/.github/workflows/build-firmware.yaml) to get new firmware bundle on https://rusefi.com/build_server/ + +3) add See also https://github.com/rusefi/rusefi/wiki/Hardware