From ae39f7001e5603010afc02de29787ade6d48ef14 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Fri, 22 Mar 2013 16:34:34 -0500 Subject: port indicator-session to GMenu/cmake. Code coverage increased from 0% to 95.4%. --- INSTALL | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 INSTALL (limited to 'INSTALL') 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 . +# + +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 + -- cgit v1.2.3 From 78e8c39d7fb8cb50b7a3cf3cca088f2b5e433166 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Sat, 23 Mar 2013 16:25:21 -0500 Subject: Add Translations.cmake for i18n files --- INSTALL | 1 + 1 file changed, 1 insertion(+) (limited to 'INSTALL') diff --git a/INSTALL b/INSTALL index ef5d8e5..1ca082b 100644 --- a/INSTALL +++ b/INSTALL @@ -18,6 +18,7 @@ Build dependencies ------------------ List of packages required to build and test the code: +- 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) -- cgit v1.2.3 From 5f9911a74ef23da8d8bc9ba5b6488da964470178 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Mon, 25 Mar 2013 15:07:21 -0500 Subject: In INSTALL, document the DBus runtime dependencies --- INSTALL | 78 ++++++++++++++++++++++++++++++++++++++--------------------------- 1 file changed, 46 insertions(+), 32 deletions(-) (limited to 'INSTALL') diff --git a/INSTALL b/INSTALL index 1ca082b..2920993 100644 --- a/INSTALL +++ b/INSTALL @@ -14,53 +14,67 @@ # along with this program. If not, see . # -Build dependencies ------------------- +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) -List of packages required to build and test the code: -- 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.ConsoleKit.Manager + - org.freedesktop.ConsoleKit.Seat + - org.freedesktop.ConsoleKit.Session + - org.freedesktop.DisplayManager.Seat + - org.freedesktop.UPower + - 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 + $ 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 + $ 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 + $ 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" -- cgit v1.2.3 From 4850b1b6ba8a1438d8c0903592108fcefc35235e Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Fri, 28 Jun 2013 10:31:51 -0500 Subject: update comments & documentation to reflect that we've replaced consolekit and login1 --- INSTALL | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'INSTALL') diff --git a/INSTALL b/INSTALL index 2920993..772eae0 100644 --- a/INSTALL +++ b/INSTALL @@ -29,11 +29,10 @@ Runtime DBus dependencies - com.canonical.indicators.webcredentials - org.freedesktop.Accounts - org.freedesktop.Accounts.User - - org.freedesktop.ConsoleKit.Manager - - org.freedesktop.ConsoleKit.Seat - - org.freedesktop.ConsoleKit.Session - org.freedesktop.DisplayManager.Seat - - org.freedesktop.UPower + - org.freedesktop.login1.Manager + - org.freedesktop.login1.Seat + - org.freedesktop.login1.User - org.gnome.ScreenSaver - org.gnome.SessionManager - org.gnome.SessionManager.EndSessionDialog -- cgit v1.2.3