annotate README @ 0:b03c3ac205e9

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