Mercurial > projects > pk-update-icon
annotate README @ 58:017b0a4b6ec5 version-3
Release version 3
| author | Guido Berhoerster <guido+pk-update-icon@berhoerster.name> |
|---|---|
| date | Mon, 02 Jul 2018 13:25:11 +0200 |
| parents | 75249ce94ca0 |
| children | c26e70b0052f |
| 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 |
|
57
75249ce94ca0
Add note that pk-update-icon is no longer developed
Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
parents:
53
diff
changeset
|
10 **pk-update-icon is no longer developed and will only receive fixes for |
|
75249ce94ca0
Add note that pk-update-icon is no longer developed
Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
parents:
53
diff
changeset
|
11 critical bugs and security issues. All users are encouraged to switch to |
|
75249ce94ca0
Add note that pk-update-icon is no longer developed
Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
parents:
53
diff
changeset
|
12 [package-update-indicator][1] which builds on modern technologies and provides |
|
75249ce94ca0
Add note that pk-update-icon is no longer developed
Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
parents:
53
diff
changeset
|
13 a number of additional features.** |
|
75249ce94ca0
Add note that pk-update-icon is no longer developed
Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
parents:
53
diff
changeset
|
14 |
|
75249ce94ca0
Add note that pk-update-icon is no longer developed
Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
parents:
53
diff
changeset
|
15 [1]: https://code.guido-berhoerster.org/projects/package-update-icon/ |
|
75249ce94ca0
Add note that pk-update-icon is no longer developed
Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
parents:
53
diff
changeset
|
16 |
|
38
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
17 Build Instructions |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
18 ------------------ |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
19 |
| 44 | 20 pk-update-icon requires a POSIX:2004 compatible operating system, it has been |
| 21 tested to work on Linux distributions. The following tools and shared | |
| 22 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
|
23 |
| 44 | 24 - GNU make >= 3.81 |
| 25 - pkg-config | |
| 26 - GNU gettext | |
| 27 - GNU or BSD install | |
|
38
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
28 - GLib version 2.30 or later |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
29 - GTK+ version 2.24 or later |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
30 - libunique |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
31 - libnotify |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
32 - PackageKit-glib2 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
33 |
| 44 | 34 Rebuilding the man pages additionally requires the xsltproc tool from libxml2. |
| 35 | |
| 36 Before building pk-update-icon check the commented macros in the Makefile for | |
| 37 any macros you may need to override depending on the used toolchain and | |
| 38 operating system. | |
| 39 | |
| 40 By default, all files will be installed under the "/usr/local" directory, a | |
| 41 different installation path prefix can be set via the `prefix` macro. In | |
| 42 addition, a second path prefix can be specified via the `DESTDIR` macro which | |
| 43 will be prepended to any path, incuding the `prefix` macro path prefix. In | |
| 44 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be | |
| 45 prepended to paths during installation and not be used for constructing | |
| 46 internal paths. | |
| 47 | |
| 48 The following instructions assume that `make` is GNU make, on some platforms | |
| 49 it may be installed under a different name or a non-default path. In order to | |
| 50 start the build process run `make all`. After a successful build, run `make | |
| 51 install` to install the program, any associated data files and the | |
| 52 documentation. | |
| 53 | |
| 54 Previously built binaries, object files, generated data files and | |
| 55 documentation can be removed by running `make clean`, any additional, | |
| 56 generated files which are not removed by the `clean` target can be removed by | |
| 57 running `make clobber`. | |
| 58 | |
| 59 Contact | |
|
38
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
60 ------- |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
61 |
| 44 | 62 Please send any feedback, translations or bug reports via email to |
|
53
7de92a24e86c
Update email address
Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
parents:
44
diff
changeset
|
63 <guido+pk-update-icon@berhoerster.name>. |
| 44 | 64 |
| 65 Bug Reports | |
| 66 ----------- | |
| 67 | |
| 68 When sending bug reports, please always mention the exact version of | |
| 69 pk-update-icon with which the issue occurs as well as the version of the | |
| 70 operating system you are using and make sure that you provide sufficient | |
| 71 information to reproduce the issue and include any input, output, any error | |
| 72 messages. | |
| 73 | |
| 74 In case of build issues, please also specify the implementations and versions | |
| 75 of the tools and shared libraries used to build the program, in particular the | |
| 76 compiler. | |
| 77 | |
| 78 In case of crashes, please generate a stack trace with a suitable debugger | |
| 79 such as gdb, lldb, dbx, or debug after a crash has occurred either by | |
| 80 examining the resulting core file or by running the program from the debugger | |
| 81 and attach it to the bug report. In order to generate a meaningful stack | |
| 82 trace the program as well as any dynamically linked libraries need to be built | |
| 83 with debugging information, see the documentation of the used compiler for the | |
| 84 required compiler flags. If any of the dynamically linked shared libraries do | |
| 85 not contain debugging information, please either install debugging information | |
| 86 for these libraries using mechanisms provided by your operating system or | |
| 87 rebuild the libraries accordingly. Please refer to the documentation of the | |
| 88 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
|
89 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
90 License |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
91 ------- |
|
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 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
|
94 distributed under the following license terms: |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
95 |
|
53
7de92a24e86c
Update email address
Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
parents:
44
diff
changeset
|
96 Copyright (C) 2014 Guido Berhoerster <guido+pk-update-icon@berhoerster.name> |
|
38
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 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
|
99 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
100 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
|
101 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
|
102 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
|
103 (at your option) any later version. |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
104 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
105 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
|
106 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
|
107 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
|
108 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
|
109 |
|
db09b66c3853
Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff
changeset
|
110 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
|
111 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
|
112 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |