← Back to branch summary

~jocave/checkbox/hybrid-amd-gpu-mods

« back to all changes in this revision

Viewing changes to checkbox-gui/README.rst

  • Committer: Zygmunt Krynicki
  • Date: 2015-09-17 13:32:37 UTC
  • mto: This revision was merged to the branch mainline in revision 4014.
  • Revision ID: zygmunt.krynicki@canonical.com-20150917133237-7d4mdzlgpin1na9g
checkbox-gui: remove checkbox gui entirely

This patch removes all of checkbox-gui. This was long in the making but
it's now done. We cannot maintain this codebase effectively. Keeping it
around slows us down as we are unable to make feature-parity changes
here with the same simplicity that we can make them elsewhere, most
notably in checkbox-converged.

The code has served us well but it is the time to let go and make
checkbox-converged the only application that we use across all of Ubuntu
releases and across different environments (phone, table and desktop).

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

Show diffs side-by-side

added added

removed removed

Lines of Context:
checkbox-gui/README.rst
1
 
Checkbox GUI
2
 
============
3
 
 
4
 
Checkbox GUI is a Qt/QML GUI running over D-Bus to control Plainbox.
5
 
 
6
 
Folder layout/structure
7
 
 
8
 
gui-engine/             Contains the D-Bus framework and C++ plugin which represents
9
 
                                plainbox classes/API
10
 
                                
11
 
checkbox-gui/   Contains the QML/Qt "skin" which is used to drive testing.
12
 
                There may be other "skins" created later...
13
 
 
14
 
External Documentation Links
15
 
============================
16
 
 
17
 
How to test and work with checkbox-gui code
18
 
======================================
19
 
To test checkbox-gui:  
20
 
        Software Needed:
21
 
                QT Creator (2.7.0 or greater)  
22
 
                Ubuntu.Components 0.1 - This is part of the Ubunutu distribution 
23
 
                        and gets updated
24
 
    How to install:
25
 
        Run the mk-venv script on the top level directory, this will add the
26
 
        required PPAs and install the needed packages.
27
 
        Optionally, to install manually:
28
 
        - sudo apt-add-repository ppa:ubuntu-sdk-team/ppa
29
 
        - sudo apt-add-repository ppa:canonical-qt5-edgers/qt5-proper
30
 
        - sudo apt-get update
31
 
        - sudo apt-get install qtcreator
32
 
        - sudo apt-get install ubuntu-sdk
33
 
        - sudo apt-get dist-upgrade
34
 
 
35
 
*NEW*. Since the UI is now getting live data through dbus, a plainbox service is required:
36
 
 
37
 
- Open a new terminal
38
 
- Change to the branch's top directory and run:
39
 
  $ mk-venv /tmp/plainbox-venv
40
 
- Activate the venv:
41
 
  $ . /tmp/plainbox-venv/bin/activate #Note the dot is significant
42
 
- Run plainbox in service mode:
43
 
  $ plainbox service
44
 
 
45
 
 
46
 
Once the required tools and dependencies are installed:
47
 
 
48
 
1. Open QT Creator
49
 
2. File->Open Project->checkbox-gui.pro
50
 
3. Build->Run
51
 
4. Interact with the UI
52
 
 
53
 
There seems to be a visual glitch when starting the UI (step 3). You may notice
54
 
that a "ghost" window opens, this looks like qt creator but it's a "mirror" or
55
 
bitmap of that window. This is the actual application window. To make it react,
56
 
simply try to move it around, or close it and restart it (the ghost window,
57
 
not qt creator itself). This bug has been reported and is being looked at.
58
 
 
59
 
TBD
60
 
 
61