~ubuntu-clock-dev/ubuntu-clock-app/reboot-packaging

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
Building and running on Utopic Desktop (14.10)
==============================================

1. Branch the code as usual and navigate to it.
	bzr branch lp:ubuntu-clock-app/reboot && cd reboot
2. Create a build dir and navigate to it.
	mkdir builddir && cd builddir
3. Build the clock app
	cmake .. && make
4. Run the clock app
	QML2_IMPORT_PATH=backend/ qmlscene ../app/ubuntu-clock-app.qml

Code Style
==========

We are trying to use a common code style throughout the code base to maintain
uniformity and improve code clarity. Listed below are the code styles guides
that will be followed based on the language used.

QML        - http://qt-project.org/doc/qt-5/qml-codingconventions.html 
JS, C++    - https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml
Python     - Code should follow PEP8 and Flake regulations

Note: In the QML code convention, ignore the Javascript code section guidelines.
So the sections that should be taken into account in the QML conventions are QML 
Object Declarations, Grouped Properties and Lists.