How to build and run

This user journey describes how to build and run the STM32Cube Software Examples on the STM32 development boards and Discovery kits.

Prerequisite: get some examples on your local disk through one of the delivery channels described in the How to get STM32Cube Software Examples ? section.

Note

The element names under brackets ( [ ] ) are to be replaced by the actual names of the elements in use.

Step 1: Project extraction

The recommended way to use an example project is in an in-project folder structure. This means that the example project, and all the files it depends on, are copied in the same root folder . This ensures that all the code is in the same place, allowing an easy tracking of the changes and dependencies.

Note

The Project Extractor tool is not an example finder. Therefore, the -p option must be used to specify the example project you want to extract. The value of the -p option is the lowest subfolder name of the example project you want to extract. In the example above, to extract the project contained in examples/hal/gpio/toggle/ , we use the value toggle for the -p option.

For the time being, the STM32Cube Software Examples are provided in a global folder structure. It is possible to use the example project in this folder structure, but it is not recommended. The impact is that all libraries are shared between all the example projects. So, any change that you make in one example project can impact the other example projects.

Warning

On the windows platform, some example projects exceed the maximum path length of 260 characters. For such examples, the global folder structure is not usable, unless you use the long path option in Windows.

Step 2: Open the IDE project

Warning

This section is not available yet.

Step 3: Build the project

Warning

This section is not available yet.

Step 4: Flash the project

Warning

This section is not available yet.

Step 5: Run the project

Warning

This section is not available yet.