=================
Ubuntu UI Toolkit
=================

Introduction
------------

This project consists of a set of QML components to ease the creation of
beautiful applications in QML for Ubuntu.

QML alone lacks built-in components for basic widgets like Button, Slider,
Scrollbar, etc, meaning a developer has to build them from scratch. This 
toolkit aims to stop this duplication of work, supplying beautiful components 
ready-made and with a clear and consistent API.

These components are fully themeable so the look and feel can be easily 
customized. Resolution independence technology is built in so UIs are scaled 
to best suit the display.

Other features:
- localisation through gettext

This project supports QML2 and above.


Building & Setup
----------------

You need Qt5 installed to proceed. To build this repository, run
$ qmake
$ make

View the components gallery by running
$ ./gallery.sh

To install these components, run
$ make install
You may need to be root for this command to succeed.

To use these components in QML without installing them, you need to set the 
QML2_IMPORT_PATH environment variable. This is done by running
$ source export_modules_dir.sh
from the root directory of this repository, but is lost when you close your 
shell.


Documentation
-------------

Once built, you may view the documentation by opening  
  documentation/html/overview-ubuntu-sdk.html
in your favorite web browser.
