aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL75
1 files changed, 75 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..6db8c1c
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,75 @@
+#
+# 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
+==================
+
+build dependencies for indicator-datetime-service
+ * glib-2.0 >= 2.36
+ * gio-unix-2.0 >= 2.36
+ * geoclue >= 0.12
+ * libical >= 0.48
+ * libecal-1.2 >= 3.5
+ * libedataserver-1.2 >= 3.5
+ * libnotify >= 0.7.6
+ * url-dispatcher-1 >= 1
+ * json-glib-1.0 >= 0.16.2
+
+
+Additional build dependencies for the gnome-control-center panel:
+ * gtk+-3.0>=3.1.4
+ * timezonemap
+ * libgnome-control-center
+ * polkit-gobject-1
+
+Build dependencies for testing / code coverage:
+ * 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
+-----------------
+ 1. $ cd indicator-datetime-X.Y.Z
+ 2. $ mkdir build
+ 3. $ cd build
+ 4. $ cmake ..
+ or
+ $ cmake -DCMAKE_INSTALL_PREFIX=/your/install/prefix/here ..
+ or
+ $ cmake -GNinja ..
+ 5. $ make
+
+Running the tests
+-----------------
+ 1. $ cd indicator-datetime-X.Y.Z
+ 2. $ mkdir build
+ 3. $ cd build
+ 4. $ cmake ..
+ 5. $ make
+ 6. $ make test
+ 7. $ make cppcheck
+
+Generating Test Coverage Reports
+--------------------------------
+ 1. $ cd indicator-datetime-X.Y.Z
+ 2. $ mkdir build-coverage
+ 3. $ cd build-coverage
+ 4. $ cmake -DCMAKE_BUILD_TYPE=coverage ..
+ 5. $ make
+ 6. $ make coverage-html
+