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