aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
blob: ef5d8e56ed9659b4a87fb2e5949e23b4a2a2b66e (plain)
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#
# Copyright (C) 2013 Canonical Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

Build dependencies
------------------

List of packages required to build and test the code:
- glib (libglib2.0, 2.35.4 or later)
- cmake (cmake, 2.8.9 or later)
- gcovr (gcovr, 2.4 or later)
- lcov (lcov, 1.9 or later)
- google test (libgtest-dev, 1.6.0 or later)
- cppcheck (cppcheck)

Building the code
-----------------

The simplest case is:

    $ cd indicator-session-X.Y.Z
    $ mkdir build
    $ cd build
    $ cmake ..
    $ make

Running the tests
-----------------

    $ cd indicator-session-X.Y.Z
    $ mkdir build
    $ cd build
    $ cmake ..
    $ make
    $ make test
    $ make cppcheck

Generating Test Coverage Reports
--------------------------------

    $ cd indicator-session-X.Y.Z
    $ mkdir build-coverage
    $ cd build-coverage
    $ cmake -DCMAKE_BUILD_TYPE=coverage ..
    $ make
    $ make coverage-html

Installation
------------

FIXME: not tested
To get files that form part of an installation, run a "make install"
in the build directory. By default, this installs them in the "install"
subdirectory of the build directory. If you want to install into a
different directory, use

$ cmake -DCMAKE_INSTALL_PREFIX=/usr/local # Or wherever...
$ make release
$ make install