Commit b0c73cad authored by David Boddie's avatar David Boddie

Merge branch 'gnome-flatpak' into 'master'

Move GNOME-specific information about Flatpak

See merge request Librem5/developer.puri.sm!146
parents 7e9d0348 751ee5a0
.. _flatpak:
.. _flatpak_setup_gnome:
Using flatpak
=============
Setting up Flatpak for GNOME Development
========================================
The `official flatpak documentation <http://docs.flatpak.org/en/latest/>`_ should be used as reference but we will provide some basic steps for installing flatpak on the dev system::
The `Flatpak documentation`_ should be used as reference but we will provide
some basic steps for installing Flatpak on the development system::
purism@pureos:~$ sudo apt-get install flatpak flatpak-builder
purism@pureos:~$ flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
purism@pureos:~$ flatpak install flathub org.gnome.Platform//3.30
.. note:: While this documentation will direct you to the stable flatpak GNOME repository, it will be common and often required to use the gnome-nightly repository instead, for example to access the master branches of GNOME Sdk and Platform. These master branches may be required to build projects such as Calls. For more information, see the `Nightly GNOME Apps <https://wiki.gnome.org/Apps/Nightly>`_ page.
.. note:: While this documentation will direct you to the stable flatpak GNOME
repository, it will be common and often required to use the
gnome-nightly repository instead, for example to access the master
branches of GNOME Sdk and Platform. These master branches may be
required to build projects such as Calls. For more information, see
the `Nightly GNOME Apps`_ page.
.. include:: /links.rst
......@@ -3,8 +3,9 @@
GNOME Builder
=============
.. note:: It is assumed that you have already gone through the :ref:`flatpak`
section to setup flatpak on your workstation.
.. note:: It is assumed that you have already gone through the
:ref:`flatpak_setup_gnome` section to setup flatpak on your
workstation.
Builder is a fantastic IDE traditionally used for building GNOME GTK+ apps however the fun doesn't have to stop there. It can build KDE apps as long as there is flatpak metadata for the application - more on that later.
......
......@@ -19,6 +19,7 @@ these tools in more detail.
.. toctree::
GNOME/Flatpak_setup
GNOME/GBuilder
GNOME/Gtk+
GNOME/Glade
......
......@@ -8,8 +8,4 @@ packages that are provided as part of the `PureOS`_ operating system running on
the phone, and flatpaks that have been created using the Flatpak suite of tools
that contain third party applications.
.. toctree::
Flatpak_setup
.. include:: /links.rst
......@@ -39,7 +39,7 @@ for app development.
Next, what kind of application format would you like?
* :ref:`flatpak` will show you how to setup flatpak on the dev board
* :ref:`flatpak_setup_gnome` will show you how to setup flatpak on the dev board
* Deb packages are the official package formats for Debian-based
distributions. A deb package is installable from the apt package manager
and what is needed for the app to be distributed by Debian.
......
......@@ -44,6 +44,13 @@ Applications for the phone can be distributed as Flatpaks - packages that can
be distributed via repositories. Documentation for the ``flatpak`` tool and
its ``flatpak-builder`` wrapper can be found in the `Flatpak documentation`_.
Flatpak runtimes are used to provide environments in which applications can be
run. These are used on the Librem 5 to provide sandboxes for applications, but
they are also used to provide up-to-date applications for developers to use in
their development environment. For example, GNOME developers may prefer to
install the latest versions of some tools -- see :ref:`flatpak_setup_gnome` for
more information about this.
Versions of these tools provided with modern GNU/Linux distributions should be
sufficient. Debian-based distributions provide packages called ``flatpak`` and
``flatpak-builder``.
......
......@@ -31,6 +31,7 @@
.. _`linux-emcraft issue 2`: https://source.puri.sm/Librem5/linux-emcraft/issues/2
.. _`Meson`: https://mesonbuild.com/
.. _`Nightly GNOME Apps`: https://wiki.gnome.org/Apps/Nightly
.. _`Ninja`: https://ninja-build.org/
.. _`PureOS`: https://pureos.net
.. _`python-evdev`: https://python-evdev.readthedocs.io/en/latest/usage.html
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment