aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorTed Gould <ted@gould.cx>2013-08-27 12:55:22 -0500
committerTed Gould <ted@gould.cx>2013-08-27 12:55:22 -0500
commitc440b9d6a1737e3be03e205e32fec64ebdfcb2df (patch)
treeb74867b600c41ff03ed87565eae38d2daaa47d5f /INSTALL
parent4661ef2d0a834509194d069466e3905aece05183 (diff)
parentb7a8f35077f950dc6dab640e759341c1c2476f5c (diff)
downloadayatana-indicator-session-c440b9d6a1737e3be03e205e32fec64ebdfcb2df.tar.gz
ayatana-indicator-session-c440b9d6a1737e3be03e205e32fec64ebdfcb2df.tar.bz2
ayatana-indicator-session-c440b9d6a1737e3be03e205e32fec64ebdfcb2df.zip
Merging trunk
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL86
1 files changed, 86 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..772eae0
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,86 @@
+#
+# 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/>.
+#
+
+Compile-time build dependencies
+-------------------------------
+ - gettext (gettext 0.18.1.1-10ubuntu3 or later)
+ - 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)
+
+Runtime DBus dependencies
+-------------------------
+ - com.canonical.indicators.webcredentials
+ - org.freedesktop.Accounts
+ - org.freedesktop.Accounts.User
+ - org.freedesktop.DisplayManager.Seat
+ - org.freedesktop.login1.Manager
+ - org.freedesktop.login1.Seat
+ - org.freedesktop.login1.User
+ - org.gnome.ScreenSaver
+ - org.gnome.SessionManager
+ - org.gnome.SessionManager.EndSessionDialog
+
+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
+------------
+
+what gets installed
+LC_ALL=C /usr/bin/intltool-merge -x -u --no-translations com.canonical.indicator.session.gschema.xml.in com.canonical.indicator.session.gschema.xml
+
+
+
+
+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
+