diff --git a/README.md b/README.md index f0eab33..d7dbf8b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Patches project files generated by CubeMX for STM32CubeIDE to work with TouchGFX When generating TouchGFX projects using CubeMX and the STM32CubeIDE application, it will clobber a bunch of settings in the project XML that require you to configure each time. Super annoying, and since ST/TouchGFX team can't get around to fixing this in a timely manner this patch was created. ## Usage -It's a .NET Core application which you can run from the command line (Windows 10). After running the utility, you should be able to refresh your project (Right-click your project, choose Refresh) and build afterwards. +It's a .NET Core application which you can run from the command line (Windows 10). After running the utility, you should be able to refresh your project (Right-click your project, choose Refresh) and build afterwards. Note that the utility will always create a backup of the project file before patching it - but as with all software you should rely on your own backups in case of the apocolypse. ### Run a pre-built release @@ -30,3 +30,7 @@ or optionally build it / run in Visual Studio. ### Notes It will patch the .cproject XML file to set the appropriate includes/source values required for building with TouchGFX. + +### Pre-Build step + +You can add this patcher as a pre-build step to your project (Project Properties -> C/C++ Build -> Settings -> Build Steps -> Pre-build steps) however I haven't found a way to get the IDE to refresh the project so you would need to build, refresh the project, then build again :-/