Skip to main content

Getting Started

A prerequisite to get started using TouchGFX is to install the newest version of TouchGFX, which is described in the Installation section.

After this is done you are ready to begin your very first TouchGFX project. It is highly recommended that you read some key sections of this documentation to get familiar with the very basic of TouchGFX concepts. The most essential section is the Development Introduction which will give you an introduction to the software and hardware components needed for a complete TouchGFX project and the activities and tools involved in creating them. It also describes how to get started doing a fast prototype using premade components.

TouchGFX Quick Start​

If you are eager to start experimenting with TouchGFX, trying out an example UI project and maybe running it on an STM32 Evaluation Kit, a wide range of TouchGFX Board Setups together with GUI Examples and Demos exists in TouchGFX Designer.

TouchGFX Board Setups + Examples and Demos​

To create a TouchGFX project based on a TouchGFX Board Setup go ahead and start the TouchGFX Designer.

Creating an application with a TouchGFX Board Setup and an Example

On the lobby in TouchGFX Designer you can select from a wide range of examples and demos to start from. You can even combine this with board specific code for a range of STM32 Evaluation Kits, so you can have an UI running on the embedded hardware right away.

If you do not have an STM32 Evaluation Kit, you can simply run the TouchGFX application on your PC. If you want to be guided through the first steps, you can have a look at the Tutorials and ''How to TouchGFX'' videos in TouchGFX Academy. Here you will be shown how to get a project up and running, ending with doing a rather complex UI application.

Board Specific Demos​

Aside from being able to combine a TouchGFX Board Setup with an Example or a Demo, TouchGFX Designer also includes some out of the box demos for specific STM32 Evaluation Kits. These are located in the Demos section under Board Specific Demo.

Creating an application with a Board Specific Demo

What's Next​

At this point it is recommended that you browse through the documentation and read the chapters that look relevant to you. This will give you an overview of the documentation, so you know where to look for more information, and it will introduce you to key TouchGFX concepts.

The main chapters are:

  • Basic Concepts: This chapter serves as background knowledge for the rest of the documentation. It introduces all the key graphics concepts that will be referenced later on. Depending on your current knowledge and which TouchGFX development activities you will do, you might want to skip some sections and consult them later if some details are unclear.
  • Development: This chapter is the main chapter of the documentation. It explains the structure of a TouchGFX Project, the workflow and the tools involved in the entire project development cycle. Each step in the workflow has it own section and is described in details. Here you will find all you need to know on how to make your application run on your hardware and how you will do UI development, including descriptions of all features and components in the TouchGFX Framework.