projects/package-update-indicator

view README @ 0:6884bb8130ca

Initial revision
author Guido Berhoerster <guido+pui@berhoerster.name>
date Sun May 20 11:32:57 2018 +0200 (2018-05-20)
parents
children a4020e99e550
line source
1 package-update-indicator
2 ========================
4 Description
5 -----------
7 The package-update-indicator utility regularly checks for software updates and
8 notifies the user about available updates using desktop notifications and
9 either a status notifier icon or a system tray icon.
11 Build Instructions
12 ------------------
14 package-update-indicator requires a POSIX:2004 compatible operating system, it
15 has been tested to work on Linux distributions. The following tools and
16 shared libraries are required to build package-update-indicator:
18 - GNU make 3.81 or later
19 - pkg-config
20 - GNU gettext 0.19 or later
21 - GNU or BSD install
22 - GLib version 2.48 or later
23 - GTK+ version 3.18 or later
24 - libappindicator 12.10.0 or later
25 - PackageKit-glib2 0.8.17 or later
26 - the xsltproc tool from libxml2
28 Before building package-update-indicator check the commented macros in the
29 Makefile for any macros you may need to override depending on the used
30 toolchain and operating system.
32 By default, all files will be installed under the "/usr/local" directory, a
33 different installation path prefix can be set via the `prefix` macro. In
34 addition, a second path prefix can be specified via the `DESTDIR` macro which
35 will be prepended to any path, incuding the `prefix` macro path prefix. In
36 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
37 prepended to paths during installation and not be used for constructing
38 internal paths.
40 The following instructions assume that `make` is GNU make, on some platforms
41 it may be installed under a different name or a non-default path. In order to
42 start the build process run `make all`. After a successful build, run `make
43 install` to install the program, any associated data files and the
44 documentation.
46 Previously built binaries, object files, generated data files and
47 documentation can be removed by running `make clean`, any additional,
48 generated files which are not removed by the `clean` target can be removed by
49 running `make clobber`.
51 Contact
52 -------
54 Please send any feedback, translations or bug reports via email to
55 <guido+pui@berhoerster.name>.
57 Bug Reports
58 -----------
60 When sending bug reports, please always mention the exact version of
61 package-update-indicator with which the issue occurs as well as the version of
62 the operating system you are using and make sure that you provide sufficient
63 information to reproduce the issue and include any input, output, any error
64 messages.
66 In case of build issues, please also specify the implementations and versions
67 of the tools and shared libraries used to build the program, in particular the
68 compiler.
70 In case of crashes, please generate a stack trace with a suitable debugger
71 such as gdb, lldb, dbx, or debug after a crash has occurred either by
72 examining the resulting core file or by running the program from the debugger
73 and attach it to the bug report. In order to generate a meaningful stack
74 trace the program as well as any dynamically linked libraries need to be built
75 with debugging information, see the documentation of the used compiler for the
76 required compiler flags. If any of the dynamically linked shared libraries do
77 not contain debugging information, please either install debugging information
78 for these libraries using mechanisms provided by your operating system or
79 rebuild the libraries accordingly. Please refer to the documentation of the
80 debugger for detailed instructions on generating backtraces.
82 License
83 -------
85 Except otherwise noted, all files are Copyright (C) 2018 Guido Berhoerster and
86 distributed under the following license terms:
88 Copyright (C) 2018 Guido Berhoerster <guido+pui@berhoerster.name>
90 Permission is hereby granted, free of charge, to any person obtaining
91 a copy of this software and associated documentation files (the
92 "Software"), to deal in the Software without restriction, including
93 without limitation the rights to use, copy, modify, merge, publish,
94 distribute, sublicense, and/or sell copies of the Software, and to
95 permit persons to whom the Software is furnished to do so, subject to
96 the following conditions:
98 The above copyright notice and this permission notice shall be included
99 in all copies or substantial portions of the Software.
101 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
102 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
103 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
104 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
105 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
106 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
107 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.