Getting Started#

In order to start writing an application for the GNOME desktop environment, you should follow these steps:

New project creation dialog in GNOME Builder New project creation dialog in GNOME Builder

  1. download and install the latest version of GNOME Builder

  2. in the Welcome screen, select Create new project…

  3. configure the project options

    • write “text-viewer” as the project’s name

    • write “com.example.TextViewer” as the project’s application id.

    • select GPL-3.0-or-later as the licensing terms for your project

  4. select the GNOME Application template

Initial project contents in GNOME Builder Initial project contents in GNOME Builder

Once Builder finishes creating your application’s project, you will find the following files:

com.example.TextViewer.json

This is the Flatpak manifest for your application. You can use the manifest to define your project’s dependencies. The default manifest depends on the lastest stable of the GNOME platform. You can also include additional dependencies not provided by the GNOME run time.

meson.build

This is the main Meson build file, which defines how and what to build in your application.

src

This is the directory with the sources of your application, as well as the UI definition files for its widgets.

src/text-viewer.gresource.xml

The GResource manifest for assets that will be built into the project using glib-compile-resources.

po/POTFILES

The list of files containing translatable, user-visible strings.

data/com.example.TextViewer.gschema.xml

The schema file for the settings of the application.

data/com.example.TextViewer.desktop.in

The desktop entry file for the application.

data/com.example.TextViewer.appdata.xml.in

The application metadata used by app stores and application distributors.

If you want to, you can now build and run the application by pressing the Run Project button, or Shift + Ctrl + Space.

Note

The code in this tutorial is available on GitLab.