annotate README @ 1:48bfb59ec26d

Add a README file and Makefile
author Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
date Mon, 09 Mar 2015 11:17:51 +0100
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
1 Sonar Openbox Theme
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
2 ===================
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
3
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
4 Description
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
5 -----------
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
6
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
7 The Sonar Openbox theme is based on the identically named Metacity theme.
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
8
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
9 Build Instructions
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
10 ------------------
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
11
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
12 The Sonar Openbox theme can either be installed via make or by copying the
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
13 "Sonar" directory into the system or per-user theme directory, typically
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
14 /usr/share/themes and ~/.themes, respectively.
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
15
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
16 The following tools are required to install the theme files via `make`:
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
17
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
18 - GNU make >= 3.81
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
19 - GNU or BSD install
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
20
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
21 Before installing the files check the commented macros in the Makefile for any
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
22 macros you may need to override depending on the used toolchain and operating
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
23 system.
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
24
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
25 By default, all files will be installed under the "/usr/local" directory, a
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
26 different installation path prefix can be set via the `prefix` macro. In
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
27 addition, a second path prefix can be specified via the `DESTDIR` macro which
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
28 will be prepended to any path, incuding the `prefix` macro path prefix. In
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
29 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
30 prepended to paths during installation and not be used for constructing
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
31 internal paths.
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
32
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
33 The following instructions assume that `make` is GNU make, on some platforms it
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
34 may be installed under a different name or a non-default path. In order to
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
35 install the theme files run `make install`.
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
36
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
37 Contact
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
38 -------
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
39
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
40 Please send any feedback or bug reports via email to
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
41 <guido+sonar-openbox-theme@berhoerster.name>.
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
42
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
43 Bug Reports
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
44 -----------
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
45
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
46 When sending bug reports, please always mention the exact version of the Sonar
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
47 Openbox theme with which the issue occurs as well as the version of Openbox
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
48 and the operating system you are using and make sure that you provide
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
49 sufficient information to reproduce the issue and include any input, output,
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
50 any error messages.
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
51
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
52 License
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
53 -------
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
54
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
55 The Sonar Openbox theme is derived from the Sonar Metacity theme and
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
56 distributed under the same license terms as the original work (see below for
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
57 the full license text):
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
58
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
59 Copyright (C) 2010 Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
60 Copyright (C) 2009 Jakub Steiner, Aaron Bockover, Novell Inc.
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
61
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
62 This program is free software; you can redistribute it and/or
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
63 modify it under the terms of the GNU General Public License
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
64 as published by the Free Software Foundation; either version 2
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
65 of the License, or (at your option) any later version.
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
66
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
67 This program is distributed in the hope that it will be useful,
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
68 but WITHOUT ANY WARRANTY; without even the implied warranty of
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
69 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
70 GNU General Public License for more details.
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
71
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
72 You should have received a copy of the GNU General Public License
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
73 along with this program; if not, write to the Free Software
48bfb59ec26d Add a README file and Makefile
Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>
parents:
diff changeset
74 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.