aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL72
1 files changed, 72 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..ef5d8e5
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,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
+