Commit acf44661 authored by Guido Gunther's avatar Guido Gunther

Merge branch 'doc-fixes' into 'master'

Add a phone section, tidy up existing sections

See merge request Librem5/developer.puri.sm!99
parents 1eb28815 3c8f8912
Pipeline #2860 passed with stage
in 10 minutes and 12 seconds
......@@ -3,35 +3,43 @@
Introduction
=============
Apps for the Librem 5 will be typically built using the open source GTK+
toolkit. In fact many of the apps available will be ported from already
existing GTK+ apps which are part of the GNOME environment. In your efforts to
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.
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
---------
- GNOME Builder
- flatpak, flatpak-builder (Your app package format)
- flatpak runtimes
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+ (UI toolkit)
- `GTK+ toolkit`
- GNOME environment (Librem 5 runs GNOME by default)
- libhandy (library with GTK+ widgets for mobile phones)
- libhandy (adaptive GTK+ widget library for mobile phones)
The Workflow
------------
A typical developer workflow will involve something of this sort:
- Install flatpak and flatpak-builder
- Install GNOME Builder
- Git checkout a Gnome app to port, or start a new GNOME Application project within GNOME Builder
- Adjust dependencies for the project to pull in libhandy or other possible requirements
- Adjust project code and/or xml files for UI changes to accommodate for mobile
- Build a flatpak from GNOME Builder
- Copy flatpak into the emulator, install flatpak on emulator, run flatpak app on emulator
- Debug issues
- Rinse and repeat until your app works well on the Librem 5 emulator
- Contribute the app or port
- Install ``flatpak`` and ``flatpak-builder``.
- Install GNOME Builder.
- Checkout a GNOME app to port, or start a new GNOME application project within
GNOME Builder.
- Adjust dependencies for the project to pull in libhandy or other possible requirements.
- Adjust project code and/or XML files for UI changes to accommodate for mobile.
- Build a flatpak for the app from within GNOME Builder.
- Copy flatpak into the emulator, install and run it within the emulator.
- Debug any issues you encounter.
- 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
.. _Publishing-Apps:
.. _publishing_apps:
Publishing Apps
===============
Publishing Applications
=======================
**The method of publishing apps is undergoing internal discussion.**
.. note:: The precise method of publishing apps is undergoing internal
discussion at Purism.
......@@ -18,7 +18,7 @@ Together, we want to improve PureOS for the Librem 5 and there are several ways
Whether it be porting/writing apps, finding defects, writing tutorials, or anything else you can think of.. you are helping the community produce a completely open source phone. We look forward to your help making technical piece of art that respects your freedom.
Note: To include your app in PureOS, please see :ref:`Publishing-Apps`
Note: To include your app in PureOS, please see :ref:`publishing_apps`.
Getting your own puri.sm email account
......
......@@ -14,4 +14,5 @@ itself, a development kit or with an emulator that runs on a workstation.
Development_Environment/Requirements.rst
Development_Environment/Boards.rst
Development_Environment/Boards/emulators.rst
Development_Environment/Phone.rst
Development_Environment/Workstation.rst
.. _phone_setup:
Setting up the Phone
====================
.. note:: This section is subject to updates and revisions prior to the phone's
release.
This section should describe the steps needed to set up the Librem 5 phone for
application development. This includes any preparations related to the
hardware, such as connecting USB cables and ensuring that the phone is powered.
It should also describe the software that needs to be installed on the phone,
such as packages that will enable or assist software development.
......@@ -3,6 +3,13 @@
Environments
============
The Librem 5 is able to run two different phone environments for applications:
phosh is developed at Purism as a mobile-friendly replacement for the
GNOME shell; Plasma Mobile is a project from the KDE project.
The following sections describe these environments in more detail, covering
the steps needed to build and install each of them.
.. toctree::
Environments/Phosh
......
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