Commit 88b9db48 authored by David Boddie's avatar David Boddie

Refactor the Apps section further

Move the Design section into the App Development Guides.
Add placeholder guides.
Tidy up the GNOME documentation.
parent 95523bc9
.. _design:
Design
======
.. toctree::
Design/Design_guidelines
Design/Constraints
Design/Apps_overview
Design/Shell
Design/Howto
......@@ -3,11 +3,12 @@
GNOME Builder
=============
.. note:: It is assumed that you have already gone through the :ref:`flatpak` section to setup flatpak on your x86 workstation.
.. note:: It is assumed that you have already gone through the :ref:`flatpak`
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.
First, checkout the `official documentation for GNOME Builder <https://builder.readthedocs.io/en/latest/>`_
First, checkout the `GNOME Builder documentation`_.
**Install the stable version of GNOME Builder**::
......@@ -146,4 +147,4 @@ You will see the application start on the screen connected to the board.
:width: 300px
:height: 400px
.. include:: /links.rst
.. _gnome:
.. _developing_apps_gnome:
Developing for GNOME
====================
Applications (apps) for the Librem 5 will typically be built using the
`GTK+ toolkit`_. In fact many of the apps available will be ported from already
existing apps which are part of the GNOME environment. When you write an app or
port a current app to the Librem 5, you are likely going to use GTK+ and the
tooling around it for development.
See the :ref:`development_environment` chapter of this manual, and especially
the :ref:`workstation` section for an overview of the tools that make up
a typical GNOME development environment. The following sections cover use of
these tools in more detail.
.. toctree::
GNOME/Intro
GNOME/GBuilder
GNOME/Gtk+
GNOME/Glade
GNOME/Resources
.. include:: /links.rst
.. _design:
Design
======
.. toctree::
Design_guidelines
Constraints
Apps_overview
Shell
Howto
.. _intro:
.. _porting_gnome_apps_guide:
Introduction
=============
Porting GNOME Applications
==========================
Applications (apps) for the Librem 5 will typically be built using the
`GTK+ toolkit`_. In fact many of the apps available will be ported from already
existing apps which are part of the GNOME environment. When you write an app or
port a current app to the Librem 5, you are likely going to use GTK+ and the
tooling around it for development.
The Tools
---------
See the :ref:`development_environment` chapter of this manual, and especially
the :ref:`workstation` section for an overview of the tools that make up a
typical development environment. This includes information on the following:
- `GNOME Builder`_
- ``flatpak``, ``flatpak-builder`` (Your app package format)
- Flatpak runtimes
- :ref:`Librem 5 emulator <qemu>`
- `GTK+ toolkit`
- GNOME environment (Librem 5 runs GNOME by default)
- libhandy (adaptive GTK+ widget library for mobile phones)
.. note:: This guide will cover the tasks associated with porting GNOME
applications to the Librem 5 phone, taking into account the different
capabilities, form factor and other constraints that make application
design different to that on laptops and desktop machines.
The Workflow
------------
A typical developer workflow will involve something of this sort:
A typical developer workflow for porting will involve something like this:
- Install ``flatpak`` and ``flatpak-builder``.
- Install GNOME Builder.
......@@ -41,5 +25,3 @@ A typical developer workflow will involve something of this sort:
- Repeat until your app works well on the Librem 5 emulator.
- Test on a development board or Librem 5.
- Contribute the app or port.
.. include:: /links.rst
......@@ -7,6 +7,12 @@ Since application development involves a wide range of topics, we aim to
provide a selection of guides that cover those that developers are most likely
to encounter. We aim to add more guides to this collection over time.
.. toctree::
:maxdepth: 1
Design/index
Porting_GNOME_Applications/index
We welcome suggestions for new guides. Please check the current
`developer.puri.sm issues`_ for existing requests and submit a new request if
necessary.
......
......@@ -8,7 +8,6 @@ Application Development
Gnome
Kde
Design
Guides/index
Packaging_Apps/index
PublishingApps
......
......@@ -6,6 +6,7 @@
.. _`git-buildpackage`: http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.html
.. _`GNOME Builder`: https://wiki.gnome.org/Apps/Builder
.. _`GNOME Builder documentation`: https://builder.readthedocs.io/en/latest/
.. _`GNOME git client`: https://wiki.gnome.org/Apps/Gitg
.. _`GNOME`: https://www.gnome.org
......
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