projects/package-update-indicator

view README @ 52:707e9e3deeac

Do not hardcode pkg-config

Using a macro allows passing a different executable in case of
cross-compilation.
author Helmut Grohne <helmut@subdivi.de>
date Sat Dec 12 01:08:21 2020 -0500 (11 months ago)
parents 2477a6151087
children
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 - upower-glib 0.99.0 or later
27 - polkit 0.105 or later
28 - the xsltproc tool from libxml2
30 Before building package-update-indicator check the commented macros in the
31 Makefile for any macros you may need to override depending on the used
32 toolchain and operating system.
34 By default the "update-command" setting is empty which means users will not be
35 offered to install updates from a notification or the indicator menu.
36 Distribution vendors may override this or any other default setting by
37 installing a vendor override file alongside the schema file. An example for
38 is distributed with package-update-indicator, see the file
39 "examples/10_vendor_update_command.gschema.override.example". For details on
40 how to install a vendor override file see the manual page for
41 glib-compile-schemas.
43 By default, all files will be installed under the "/usr/local" directory, a
44 different installation path prefix can be set via the `prefix` macro. In
45 addition, a second path prefix can be specified via the `DESTDIR` macro which
46 will be prepended to any path, incuding the `prefix` macro path prefix. In
47 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
48 prepended to paths during installation and not be used for constructing
49 internal paths.
51 The following instructions assume that `make` is GNU make, on some platforms
52 it may be installed under a different name or a non-default path. In order to
53 start the build process run `make all`. After a successful build, run `make
54 install` to install the program, any associated data files and the
55 documentation.
57 Previously built binaries, object files, generated data files and
58 documentation can be removed by running `make clean`, any additional,
59 generated files which are not removed by the `clean` target can be removed by
60 running `make clobber`.
62 Contact
63 -------
65 Please send any feedback, translations or bug reports via email to
66 <guido+pui@berhoerster.name>.
68 Bug Reports
69 -----------
71 When sending bug reports, please always mention the exact version of
72 package-update-indicator with which the issue occurs as well as the version of
73 the operating system you are using and make sure that you provide sufficient
74 information to reproduce the issue and include any input, output, any error
75 messages.
77 In case of build issues, please also specify the implementations and versions
78 of the tools and shared libraries used to build the program, in particular the
79 compiler.
81 In case of crashes, please generate a stack trace with a suitable debugger
82 such as gdb, lldb, dbx, or debug after a crash has occurred either by
83 examining the resulting core file or by running the program from the debugger
84 and attach it to the bug report. In order to generate a meaningful stack
85 trace the program as well as any dynamically linked libraries need to be built
86 with debugging information, see the documentation of the used compiler for the
87 required compiler flags. If any of the dynamically linked shared libraries do
88 not contain debugging information, please either install debugging information
89 for these libraries using mechanisms provided by your operating system or
90 rebuild the libraries accordingly. Please refer to the documentation of the
91 debugger for detailed instructions on generating backtraces.
93 License
94 -------
96 Except otherwise noted, all files are Copyright (C) 2018 Guido Berhoerster and
97 distributed under the following license terms:
99 Copyright (C) 2018 Guido Berhoerster <guido+pui@berhoerster.name>
101 Permission is hereby granted, free of charge, to any person obtaining
102 a copy of this software and associated documentation files (the
103 "Software"), to deal in the Software without restriction, including
104 without limitation the rights to use, copy, modify, merge, publish,
105 distribute, sublicense, and/or sell copies of the Software, and to
106 permit persons to whom the Software is furnished to do so, subject to
107 the following conditions:
109 The above copyright notice and this permission notice shall be included
110 in all copies or substantial portions of the Software.
112 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
113 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
114 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
115 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
116 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
117 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
118 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.