diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Mon Mar 09 11:17:51 2015 +0100
@@ -0,0 +1,74 @@
+Sonar Openbox Theme
+===================
+
+Description
+-----------
+
+The Sonar Openbox theme is based on the identically named Metacity theme.
+
+Build Instructions
+------------------
+
+The Sonar Openbox theme can either be installed via make or by copying the
+"Sonar" directory into the system or per-user theme directory, typically
+/usr/share/themes and ~/.themes, respectively.
+
+The following tools are required to install the theme files via `make`:
+
+- GNU make >= 3.81
+- GNU or BSD install
+
+Before installing the files check the commented macros in the Makefile for any
+macros you may need to override depending on the used toolchain and operating
+system.
+
+By default, all files will be installed under the "/usr/local" directory, a
+different installation path prefix can be set via the `prefix` macro.  In
+addition, a second path prefix can be specified via the `DESTDIR` macro which
+will be prepended to any path, incuding the `prefix` macro path prefix.  In
+contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
+prepended to paths during installation and not be used for constructing
+internal paths.
+
+The following instructions assume that `make` is GNU make, on some platforms it
+may be installed under a different name or a non-default path.  In order to
+install the theme files run `make install`.
+
+Contact
+-------
+
+Please send any feedback or bug reports via email to
+<guido+sonar-openbox-theme@berhoerster.name>.
+
+Bug Reports
+-----------
+
+When sending bug reports, please always mention the exact version of the Sonar
+Openbox theme with which the issue occurs as well as the version of Openbox
+and the operating system you are using and make sure that you provide
+sufficient information to reproduce the issue and include any input, output,
+any error messages.
+
+License
+-------
+
+The Sonar Openbox theme is derived from the Sonar Metacity theme and
+distributed under the same license terms as the original work (see below for
+the full license text):
+
+Copyright (C) 2010 Guido Berhoerster <guido+sonar-openbox-theme@berhoerster.name>  
+Copyright (C) 2009 Jakub Steiner, Aaron Bockover, Novell Inc.
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.