Skip to content

Latest commit

 

History

History
92 lines (58 loc) · 2.17 KB

README.md

File metadata and controls

92 lines (58 loc) · 2.17 KB
Raw

Green Island

This is Green Island, a support library to make Qt-based Wayland compositors development easier.

The name comes from Kure Atoll, Hawaii.

The API is based on QtCompositor which is shipped by the qtwayland module.

Green Island can be used by any desktop environment that wish to implement its compositor by using QML or for shells deeply integrated with the compositor in the same process.

Dependencies

In order to build and install Green Island you need Wayland 1.6 and Qt 5.4 with at least the following modules:

  • qtbase
  • qtdeclarative
  • qtwayland

The Wayland site has some information on how to build it:

http://wayland.freedesktop.org/building.html

You can either build Qt from git yourself or download binaries.

More information about building Qt from git can be found here:

http://qt-project.org/wiki/Building-Qt-5-from-Git

Qt 5 binaries can be downloaded from http://qt-project.org/downloads

A development version of qtwayland is required:

git clone -b output54 https://github.com/maui-packages/qtwayland

and build it yourself.

You also need the following modules from KDE Frameworks 5:

  • libkscreen (from master)

Build

Building Green Island is a piece of cake.

Assuming you are in the source directory, just create a build directory and run cmake:

mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/opt/hawaii ..

To do a debug build the last command can be:

cmake -DCMAKE_INSTALL_PREFIX=/opt/hawaii -DCMAKE_BUILD_TYPE=Debug ..

To do a release build instead it can be:

cmake -DCMAKE_INSTALL_PREFIX=/opt/hawaii -DCMAKE_BUILD_TYPE=Release ..

If not passed, the CMAKE_INSTALL_PREFIX parameter defaults to /usr/local. You have to specify a path that fits your needs, /opt/hawaii is just an example.

Package maintainers would pass -DCMAKE_INSTALL_PREFIX=/usr.

The CMAKE_BUILD_TYPE parameter allows the following values:

  • Debug: debug build
  • Release: release build
  • RelWithDebInfo: release build with debugging information

Installation

It's really easy, it's just a matter of typing:

make install

from the build directory.