Commit 3a278666 authored by David Boddie's avatar David Boddie
Browse files

Update kernel version and compositor information

parent 582e6dcb
Pipeline #45191 passed with stage
in 1 minute and 6 seconds
......@@ -10,9 +10,9 @@ This chapter provides information about the software components used in the
Librem 5 stack and includes links to useful external resources.
The Librem 5 will be an i.MX8 phone running PureOS, a Debian derivative. The
kernel will be the 4.18 mainline kernel with some additional drivers. For the
graphical windowing system, it makes use of Rootston, a Wayland compositor,
together with a bespoke shell named phosh. The graphical environment is based
kernel will be the 5.3 mainline kernel with some additional drivers. For the
graphical environment, it makes use of Phoc_, a Wayland-based compositor,
together with a bespoke shell named :ref:`Phosh`. The graphical environment is based
on the GNOME platform with a variety of modifications.
Below you can find a diagram on the overall software architecture stack.
......@@ -27,3 +27,5 @@ Below you can find a diagram on the overall software architecture stack.
Software_Reference/Linux_Kernel
Software_Reference/Environments
Software_Reference/Wayland
.. include:: /links.txt
......@@ -15,5 +15,4 @@ and uses a custom Wayland compositor.
Phosh/Install
.. _rootston: https://github.com/swaywm/wlroots
.. _GNOME: https://developer.gnome.org
.. include:: /links.txt
......@@ -3,17 +3,17 @@
Installation
============
*Phosh* runs on the development images by default but in case
you want to hack on it you need to build from source.
Phosh runs on the development images by default. If you want to hack on it, you
need to build it from source, obtained from the `Phosh repository`_.
.. index:: Building phosh
Building phosh
Building Phosh
--------------
To install *phosh* follow the `README`_. If you want to run *phosh*
from the source tree you can omit the ``ninja -C _build install``
step.
To install Phosh, follow the instructions in the `README`_ file from the
repository. If you want to run it from the source tree you can omit the
``ninja -C _build install`` step.
.. index:: Building rootston
......@@ -40,3 +40,4 @@ shipped by *phosh*::
../wlroots/rootston/rootston -C ./rootston.ini -E _build/run
.. _README: https://source.puri.sm/Librem5/phosh/blob/master/README.md
.. include:: /links.txt
......@@ -43,6 +43,7 @@
.. _`GNOME API Reference`: https://developer.gnome.org/references
.. _`GNOME Builder`: https://wiki.gnome.org/Apps/Builder
.. _`GNOME Builder documentation`: https://builder.readthedocs.io/en/latest/
.. _`GNOME developer documentation`: https://developer.gnome.org
.. _`GNOME git client`: https://wiki.gnome.org/Apps/Gitg
.. _`GNOME`: https://www.gnome.org
.. _`GNOME Human Interface Guidelines`: https://developer.gnome.org/hig/stable/
......@@ -128,6 +129,8 @@
.. _`Nightly GNOME Apps`: https://wiki.gnome.org/Apps/Nightly
.. _`Ninja`: https://ninja-build.org/
.. _`Packaging Your Product`: https://www.debian.org/doc/manuals/distribute-deb/distribute-deb.html#packaging
.. _Phoc: https://source.puri.sm/Librem5/phoc/
.. _`Phosh repository`: https://source.puri.sm/Librem5/phosh/
.. _`Plasma Mobile`: https://www.plasma-mobile.org
.. _`Plasma Mobile application development`: https://docs.plasma-mobile.org/AppDevelopment.html
.. _`Issues for Plasma Mobile on Librem 5`: https://source.puri.sm/groups/Librem5/Plasma/-/issues
......@@ -149,6 +152,7 @@
.. _`Qt documentation`: https://doc.qt.io/qt-5
.. _`Qt Quick`: https://doc.qt.io/qt-5/qtquick-index.html
.. _`Qt Quick Controls 2`: https://doc.qt.io/qt-5/qtquickcontrols2-index.html
.. _rootston: https://github.com/swaywm/wlroots
.. _`Running GTK Applications`: https://developer.gnome.org/gtk3/stable/gtk-running.html
.. _`Sandbox Permissions`: http://docs.flatpak.org/en/latest/sandbox-permissions-reference.html
.. _`Scalable Vector Graphics`: https://www.w3.org/TR/SVG/
......
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