annotate README @ 1:12e6616ee949 version-1

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