// readme

Phosh

A pure Wayland shell for mobile devices like smart phones or small tablets which

  • use touch input
  • are running battery powered most of the time
  • have limited screen space
  • have a limited number of buttons
  • might be docked to a keyboard, screen and other input devices

Typical devices are the Librem 5 and PinePhone or devices formerly running proprietary operating systems like the OnePlus 6/6T.

The companion Wayland compositor is [phoc][].

License

phosh is licensed under the GPL-3.0-or-later licence.

Getting the source

git clone https://gitlab.gnome.org/World/Phosh/phosh
cd phosh

The [main][] branch has the current development version.

Dependencies

On a Debian based system run

sudo apt -y install build-essential
sudo apt -y build-dep .

For an explicit list of dependencies check the Build-Depends entry in the [debian/control][] file.

Building

We use the meson (and thereby Ninja) build system for phosh. The quickest way to get going is to do the following:

meson setup _build
meson compile -C _build

Testing

To run the tests run

xvfb-run meson test --no-suite screenshots -C _build

For details seeโ€ฆ