|
289.3.1
by Gerry Boland
Improve README to include introduction and build instructions |
1 |
=================
|
2 |
Ubuntu UI Toolkit |
|
3 |
=================
|
|
4 |
||
5 |
Introduction
|
|
6 |
------------
|
|
7 |
||
8 |
This project consists of a set of QML components to ease the creation of |
|
9 |
beautiful applications in QML for Ubuntu. |
|
10 |
||
11 |
QML alone lacks built-in components for basic widgets like Button, Slider, |
|
12 |
Scrollbar, etc, meaning a developer has to build them from scratch. This |
|
13 |
toolkit aims to stop this duplication of work, supplying beautiful components |
|
14 |
ready-made and with a clear and consistent API. |
|
15 |
||
16 |
These components are fully themeable so the look and feel can be easily |
|
17 |
customized. Resolution independence technology is built in so UIs are scaled |
|
18 |
to best suit the display. |
|
19 |
||
20 |
Other features: |
|
21 |
- localisation through gettext |
|
22 |
||
23 |
This project supports QML2 and above. |
|
24 |
||
25 |
||
26 |
Building & Setup |
|
27 |
----------------
|
|
28 |
||
29 |
You need Qt5 installed to proceed. To build this repository, run |
|
30 |
$ qmake |
|
31 |
$ make |
|
32 |
||
|
439.1.1
by Kaleo
Rebased Ubuntu UI Toolkit component gallery on trunk |
33 |
View the components gallery by running |
34 |
$ ./gallery.sh |
|
|
289.3.1
by Gerry Boland
Improve README to include introduction and build instructions |
35 |
|
36 |
To install these components, run |
|
37 |
$ make install |
|
38 |
You may need to be root for this command to succeed. |
|
39 |
||
40 |
To use these components in QML without installing them, you need to set the |
|
|
412.1.2
by Kaleo
QML2_IMPORT_PATH instead of QML_IMPORT_PATH2. Must have been drunk. |
41 |
QML2_IMPORT_PATH environment variable. This is done by running |
|
289.3.1
by Gerry Boland
Improve README to include introduction and build instructions |
42 |
$ source export_modules_dir.sh |
43 |
from the root directory of this repository, but is lost when you close your |
|
44 |
shell. |
|
45 |
||
46 |
||
47 |
Documentation
|
|
48 |
-------------
|
|
49 |
||
50 |
Once built, you may view the documentation by opening |
|
|
971.1.1
by Didier Roche
remove the doc generation for UITK autopilot emulator. Autopilot is in universe for now, it needs MIRing first |
51 |
documentation/html/overview-ubuntu-sdk.html |
52 |
in your favorite web browser. |
|
|
1376.4.1
by nskaggs
add autopilot-helpers to build |
53 |
|
54 |
Autopilot SDK Helpers Documentation (Sphinx docs): |
|
55 |
++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
56 |
||
57 |
To build the Autopilot SDK Helpers documentation, you need to install sphinx. |
|
58 |
After installation, change directory to documentation/autopilot-helpers |
|
59 |
and executing make. |
|
60 |
||
61 |
* $ sudo apt-get install python3-sphinx |
|
62 |
||
63 |
* $ cd documentation/autopilot-helpers |
|
64 |
||
65 |
* $ make singlehtml |
|
66 |
||
67 |
* Once built, you may view the documentation by opening |
|
68 |
`_build/singlehtml/index.html` in your favorite web browser. |