hs-wayland-scanner-0.1.0: examples/hello-world/README.md

About
=====

A simple standalone client that demonstrates `XDG-shell` handshaking
and renders a semi-transparent blue window using `POSIX` shared
memory.

It also uses opaque pointers for managing the state.

Building
========

Use `hws -c hs-wayland-scanner.cfg` to generate the bindings:

``` shell
cd examples/hello-world
/path/to/hws -c hs-wayland-scanner.cfg
```

Alternatively run:

``` shell
/path/to/hws -p ./  protocols/wayland.xml protocols/xdg-shell.xml
```

Now you can build it with `cabal`:

``` shell
cabal [run|build|install]
```

Run with:

``` shell
/path/to/hello-world
```

or, if `WAYLAND_DISPLAY` is not set:

``` shell
WAYLAND_DISPLAY="wayland-0" /path/to/hello-world
```

Documentation
=============

This example exposes a library also to show the documentation
generated by `hws`. To produce the documentation run:

``` shell
cabal haddock
```