annotate README @ 0:3416304cadc9

Initial revision
author Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
date Mon, 09 Mar 2015 13:00:13 +0100
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
1 Kelabu xfwm4 Theme
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
2 ==================
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
3
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
4 Description
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
5 -----------
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
6
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
7 The Kelabu xfwm4 theme is a neutral, grayish theme.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
8
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
9 Build Instructions
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
10 ------------------
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
11
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
12 Distributions of released versions already include pregenerated images.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
13
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
14 The following tools are required to (re)generate the PNG and XPM images from
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
15 their sources:
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
16
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
17 - GNU make >= 3.81
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
18 - GNU or BSD install
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
19 - Imagemagick or GraphicsMagick
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
20
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
21 Before generating the images check the commented macros in the Makefile for any
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
22 macros you may need to override depending on the used toolchain and operating
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
23 system.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
24
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
25 By default, all files will be installed under the "/usr/local" directory, a
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
26 different installation path prefix can be set via the `prefix` macro. In
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
27 addition, a second path prefix can be specified via the `DESTDIR` macro which
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
28 will be prepended to any path, incuding the `prefix` macro path prefix. In
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
29 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
30 prepended to paths during installation and not be used for constructing
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
31 internal paths.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
32
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
33 The following instructions assume that `make` is GNU make, on some platforms
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
34 it may be installed under a different name or a non-default path. In order to
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
35 start the build process run `make all`. After a successful build, run `make
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
36 install` to install the theme files.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
37
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
38 Previously generated images can be removed by running `make clean`.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
39
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
40 Contact
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
41 -------
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
42
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
43 Please send any feedback or bug reports via email to
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
44 <guido+kelabu-xfwm4-theme@berhoerster.name>.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
45
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
46 Bug Reports
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
47 -----------
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
48
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
49 When sending bug reports, please always mention the exact version of the
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
50 Kelabu xfwm4 theme with which the issue occurs as well as the version of xfwm4
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
51 and the operating system you are using and make sure that you provide
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
52 sufficient information to reproduce the issue and include any input, output,
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
53 any error messages.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
54
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
55 In case of build issues, please also specify the implementations and versions
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
56 of the tools you are using.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
57
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
58 License
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
59 -------
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
60
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
61 The Kelabu xfwm4 theme is derived from the Gilouche Metacity theme and
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
62 distributed under the same license terms as the original work (see below for
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
63 the full license text):
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
64
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
65 Copyright (C) 2011 Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
66 Copyright (C) 2006-2008 Novell
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
67
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
68 This program is free software; you can redistribute it and/or
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
69 modify it under the terms of the GNU General Public License
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
70 as published by the Free Software Foundation; either version 2
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
71 of the License, or (at your option) any later version.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
72
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
73 This program is distributed in the hope that it will be useful,
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
74 but WITHOUT ANY WARRANTY; without even the implied warranty of
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
75 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
76 GNU General Public License for more details.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
77
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
78 You should have received a copy of the GNU General Public License
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
79 along with this program; if not, write to the Free Software
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
80 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
3416304cadc9 Initial revision
Guido Berhoerster <guido+kelabu-xfwm4-theme@berhoerster.name>
parents:
diff changeset
81