README.md 1.66 KB
Newer Older
Guido Gunther's avatar
Guido Gunther committed
1 2
# Phosh

Guido Gunther's avatar
Guido Gunther committed
3
a trivial wayland shell for prototyping things.
Guido Gunther's avatar
Guido Gunther committed
4 5 6 7 8 9 10

## License

phosh is licensed under the GPLv3+.

## Dependencies

11 12
    sudo apt-get install libgnome-desktop-3-dev libgtk-3-dev libpam0g-dev libupower-glib-dev libwayland-dev meson

13
Until distros ship [libhandy](https://source.puri.sm/Librem5/libhandy) you
14
need to build that from source as well.
Guido Gunther's avatar
Guido Gunther committed
15 16 17 18 19 20

## Building

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

Guido Gunther's avatar
Guido Gunther committed
21 22 23
    meson . _build
    ninja -C _build
    ninja -C _build install
Guido Gunther's avatar
Guido Gunther committed
24

25 26

## Running
27 28 29
### Running from the source tree
When running from the source tree start the compositor *rootston*. Then start
*phosh* using:
30 31 32

    _build/run

33
or in one command:
34 35 36

    ../wlroots/_build/rootston/rootston -E _build/run -C ./rootston.ini

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
This will make sure the needed gsettings schema is found.

### Running from the Debian packages
If installed via the Debian packages you can also run phosh via gnome-session.
It ships a file in /usr/share/gnome-session/sessions so you can bring up a
session using

    gnome-session --disable-acceleration-check --session=phosh

This assumes you have the compositor already running. If you want to start
phosh at system boot there's a systemd unit file in */lib/systemd/system/phosh*
which is disabled by default:

    systemctl enable phosh
    systemctl start phosh

This runs *phosh* as user *purism* (which needs to exist). If you don't have a
user *purism* and don't want to create on you can make systemd run *phosh* as
any user by using an override file:

    $ cat /etc/systemd/system/phosh.service.d/override.conf
    [Service]
    User=<your_user>
    WorkingDirectory=<your_home_directory>