Mercurial > projects > pk-update-icon
annotate README @ 51:f119075975e8 version-2
Release version 2
| author | Guido Berhoerster <gber@opensuse.org> |
|---|---|
| date | Fri, 19 Jun 2015 13:08:33 +0200 |
| parents | cf2421217491 |
| children | 7de92a24e86c |
| rev | line source |
|---|---|
|
38
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
1 pk-update-icon |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
2 ============== |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
3 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
4 Description |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
5 ----------- |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
6 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
7 pk-update-icon displays notifications and an icon in the tray area of the panel |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
8 when package updates are available. |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
9 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
10 Build Instructions |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
11 ------------------ |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
12 |
| 44 | 13 pk-update-icon requires a POSIX:2004 compatible operating system, it has been |
| 14 tested to work on Linux distributions. The following tools and shared | |
| 15 libraries are required to build pk-update-icon: | |
|
38
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
16 |
| 44 | 17 - GNU make >= 3.81 |
| 18 - pkg-config | |
| 19 - GNU gettext | |
| 20 - GNU or BSD install | |
|
38
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
21 - GLib version 2.30 or later |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
22 - GTK+ version 2.24 or later |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
23 - libunique |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
24 - libnotify |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
25 - PackageKit-glib2 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
26 |
| 44 | 27 Rebuilding the man pages additionally requires the xsltproc tool from libxml2. |
| 28 | |
| 29 Before building pk-update-icon check the commented macros in the Makefile for | |
| 30 any macros you may need to override depending on the used toolchain and | |
| 31 operating system. | |
| 32 | |
| 33 By default, all files will be installed under the "/usr/local" directory, a | |
| 34 different installation path prefix can be set via the `prefix` macro. In | |
| 35 addition, a second path prefix can be specified via the `DESTDIR` macro which | |
| 36 will be prepended to any path, incuding the `prefix` macro path prefix. In | |
| 37 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be | |
| 38 prepended to paths during installation and not be used for constructing | |
| 39 internal paths. | |
| 40 | |
| 41 The following instructions assume that `make` is GNU make, on some platforms | |
| 42 it may be installed under a different name or a non-default path. In order to | |
| 43 start the build process run `make all`. After a successful build, run `make | |
| 44 install` to install the program, any associated data files and the | |
| 45 documentation. | |
| 46 | |
| 47 Previously built binaries, object files, generated data files and | |
| 48 documentation can be removed by running `make clean`, any additional, | |
| 49 generated files which are not removed by the `clean` target can be removed by | |
| 50 running `make clobber`. | |
| 51 | |
| 52 Contact | |
|
38
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
53 ------- |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
54 |
| 44 | 55 Please send any feedback, translations or bug reports via email to |
| 56 <gber@opensuse.org>. | |
| 57 | |
| 58 Bug Reports | |
| 59 ----------- | |
| 60 | |
| 61 When sending bug reports, please always mention the exact version of | |
| 62 pk-update-icon with which the issue occurs as well as the version of the | |
| 63 operating system you are using and make sure that you provide sufficient | |
| 64 information to reproduce the issue and include any input, output, any error | |
| 65 messages. | |
| 66 | |
| 67 In case of build issues, please also specify the implementations and versions | |
| 68 of the tools and shared libraries used to build the program, in particular the | |
| 69 compiler. | |
| 70 | |
| 71 In case of crashes, please generate a stack trace with a suitable debugger | |
| 72 such as gdb, lldb, dbx, or debug after a crash has occurred either by | |
| 73 examining the resulting core file or by running the program from the debugger | |
| 74 and attach it to the bug report. In order to generate a meaningful stack | |
| 75 trace the program as well as any dynamically linked libraries need to be built | |
| 76 with debugging information, see the documentation of the used compiler for the | |
| 77 required compiler flags. If any of the dynamically linked shared libraries do | |
| 78 not contain debugging information, please either install debugging information | |
| 79 for these libraries using mechanisms provided by your operating system or | |
| 80 rebuild the libraries accordingly. Please refer to the documentation of the | |
| 81 debugger for detailed instructions on generating backtraces. | |
|
38
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
82 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
83 License |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
84 ------- |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
85 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
86 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
87 distributed under the following license terms: |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
88 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
89 Copyright (C) 2014 Guido Berhoerster <gber@opensuse.org> |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
90 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
91 Licensed under the GNU General Public License Version 2 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
92 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
93 This program is free software; you can redistribute it and/or modify |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
94 it under the terms of the GNU General Public License as published by |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
95 the Free Software Foundation; either version 2 of the License, or |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
96 (at your option) any later version. |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
97 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
98 This program is distributed in the hope that it will be useful, |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
99 but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
100 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
101 GNU General Public License for more details. |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
102 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
103 You should have received a copy of the GNU General Public License |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
104 along with this program; if not, write to the Free Software |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
105 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |