Overview.rst 2.15 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
Overview of Files and Directories
=================================

The main ``app`` directory contains the following files and directories. Those
marked with a trailing slash are directories.

====================================== =========================================
Name                                   Description
====================================== =========================================
**build-aux/**                         Helper scripts for the build system.
**com.example.app_resources.json**     Manifest file for deployment.
**data/**                              Data files for the installed application.
**meson.build**                        The main build file.
**src/**                               Source files for the application.
====================================== =========================================

The first four of these are concerned with building and packaging the
application, or contain data files that are not part of the application itself.

20 21 22
Sources and Resources
---------------------

23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
The ``src`` directory is where we will start to explore how the application is
put together. It contains a collection of files and an ``images`` directory.

====================================== =========================================
Name                                   Description
====================================== =========================================
**app_resources.gresource.xml**        Resource description file.
**app-resources.in**                   Template executable file.
**images/**                            Images that will be stored in the
                                       resource bundle.
**__init__.py**                        Python package file.
**main.py**                            The main module for the application.
**meson.build**                        The build file for this directory.
====================================== =========================================

The ``meson.build`` file describes the build rules for the program -- we will
look at these later in :ref:`App_Resources_tutorial_building`.
40 41 42

Next, we will look at the ``app_resources.gresource.xml`` file and how
resources are described.