# gmobile

gmobile carries some helpers for glib based environments on mobile devices.
Some of those parts might move to glib or libgnome-desktop eventually. It can
be used as a shared library or git submodule. There aren't any API stability
guarantees at this point in time.

## License

gmobile is licensed under the GPL-3-or-later and LGPLv2.1-or-later.

## Getting the source

```sh
    git clone https://gitlab.gnome.org/World/Phosh/gmobile.git
    cd gmobile.git
```

The `main` branch has the current development version.

## Dependencies

See `meson.build` for required dependencies.

## Building

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

```sh
    meson setup _build
    meson compile -C _build
```

## API docs

API documentation is available at <https://world.pages.gitlab.gnome.org/Phosh/gmobile/>

## Adding a new device

If you want to add display panel information for a new device see
this post on [notch support](https://phosh.mobi/posts/notch-support/).

If you want to add support for wakeup keys see the
[manpage](./doc/gmobile.udev.rst) and the post on [wakeup keys][].

## Getting in Touch

* Issue tracker: <https://gitlab.gnome.org/World/Phosh/gmobile/-/issues>
* Matrix: <https://matrix.to/#/#phosh:phosh.mobi>

[wakeup keys]: https://phosh.mobi/posts/wakeup-keys/
