Merge pull request #27 from Omnikron13/cleanup

Merging in automated patching over upstream source

Author: Omnikron13

Diff for: .gitignore

@@ -1,13 +1 @@
-node_modules
-Makefile
-Makefile.in
-aclocal.m4
-autom4te.cache
-build-aux
-compile
-config.*
-configure
-install-sh
-missing
-.idea/
-*.iml
+arc-theme-*/

Diff for: .nvmrc

@@ -1,7 +1,7 @@
 # SolArc Theme
-SolArc is a flat theme with transparent elements for GTK 3, GTK 2 and Gnome-Shell which supports GTK 3 and GTK 2 based desktop environments like Gnome, Unity, Budgie, Pantheon, XFCE, Mate, etc.
+SolArc is a flat theme with transparent elements for GTK 3, GTK 2 and GNOME Shell which supports GTK 3 and GTK 2 based desktop environments like GNOME, Unity, Pantheon, Xfce, MATE, Cinnamon (>=3.4), Budgie Desktop (10.4 for GTK+3.22) etc.
 
-SolArc is a fork of the Arc theme: https://github.com/horst3180/arc-theme
+SolArc is a fork of the Arc theme: https://github.com/NicoHood/arc-theme
 
 Colours are based on the Solarized colour scheme by [Ethan Schoonover](https://github.com/altercation): https://github.com/altercation/solarized
 
@@ -20,31 +20,6 @@ If you like SolArc and want to help improve it, please get in touch! I don't hav
 ### SolArc-Dark
 ![A screenshot of the Arc-Dark theme](https://github.com/apheleia/solarc-theme/blob/master/images/preview-dark.png?raw=true)
 
-
-## Requirements
-* Gnome/GTK3 3.14 - 3.22
-* The `gnome-themes-standard` package
-* The murrine engine. This has different names depending on your distro.
-  * `gtk-engine-murrine` (Arch Linux)
-  * `gtk2-engines-murrine` (Debian, Ubuntu, elementary OS)
-  * `gtk-murrine-engine` (Fedora)
-  * `gtk2-engine-murrine` (openSUSE)
-  * `gtk-engines-murrine` (Gentoo)
-
-Main distributions that meet these requirements are
-
-* Arch Linux and Arch Linux based distros
-* Ubuntu 15.04 or newer (**Ubuntu 14.04 and 14.10 are not supported**)
-* elementary OS Freya/Loki
-* Debian 8, Testing or Unstable
-* Gentoo
-* Fedora 21 or newer
-* openSUSE 13.2, Leap 42.1 and Tumbleweed
-
-Derivatives of these distributions should work, as well.
-
-If your distribution isn't listed, please check the requirements yourself.
-
 ## Installation
 ### Arch Linux
 You can install the AUR package: [gtk-theme-solarc-git](https://aur.archlinux.org/packages/gtk-theme-solarc-git/)
@@ -56,14 +31,31 @@ You can install the AUR package: [gtk-theme-solarc-git](https://aur.archlinux.or
     rm -rf ~/.local/share/themes/{SolArc,SolArc-Darker,SolArc-Dark}
     rm -rf ~/.themes/{SolArc,SolArc-Darker,SolArc-Dark}
 
-To build the theme you'll need
+To build the theme the following packages are required
 * `autoconf`
 * `automake`
-* `pkg-config` or `pkgconfig` if you use Fedora
-* `libgtk-3-dev` for Debian based distros or `gtk3-devel` for RPM based distros
-* `git` if you want to clone the source directory
-
-If your distributions doesn't ship separate development packages you just need GTK 3 instead of the `-dev` packages.
+* `wget` for pulling the Arc source
+* `sassc` for GTK 3, Cinnamon, or GNOME Shell
+* `pkg-config` or `pkgconfig` for Fedora
+* `git` to clone the source directory
+* `optipng` for GTK 2, GTK 3, or XFWM
+* `inkscape` for GTK 2, GTK 3, or XFWM
+
+The following packages are optionally required
+* `gnome-shell`for auto-detecting the GNOME Shell version
+* `libgtk-3-dev` for Debian based distros or `gtk3-devel` for RPM based distros, for auto-detecting the GTK3 version
+
+**Note:** For distributions which don't ship separate development packages, just the GTK 3 package is needed instead of the `-dev` packages.
+
+For the theme to function properly, install the following
+* GNOME Shell 3.18 - 3.32, GTK 3.18 - 3.24
+* The `gnome-themes-extra` package
+* The murrine engine. This has different names depending on the distro.
+  * `gtk-engine-murrine` (Arch Linux)
+  * `gtk2-engines-murrine` (Debian, Ubuntu, elementary OS)
+  * `gtk-murrine-engine` (Fedora)
+  * `gtk2-engine-murrine` (openSUSE)
+  * `gtk-engines-murrine` (Gentoo)
 
 Install the theme with the following commands
 
@@ -73,38 +65,48 @@ If you want to install the latest version from git, clone the repository with
 
     git clone https://github.com/apheleia/solarc-theme --depth 1 && cd solarc-theme
 
-**2. Build and install the theme**
+**2. Download & patch the Arc theme source**
+
+    ./solarize.sh
+
+**3. Build and install the patched theme**
 
+    cd arc-theme-[version]
     ./autogen.sh --prefix=/usr
     sudo make install
 
 Other options to pass to autogen.sh are
 
-    --disable-transparency     disable transparency in the GTK3 theme
-    --disable-light            disable SolArc Light support
-    --disable-darker           disable SolArc Darker support
-    --disable-dark             disable SolArc Dark support
-    --disable-cinnamon         disable Cinnamon support
-    --disable-gnome-shell      disable GNOME Shell support
-    --disable-gtk2             disable GTK2 support
-    --disable-gtk3             disable GTK3 support
-    --disable-metacity         disable Metacity support
-    --disable-unity            disable Unity support
-    --disable-xfwm             disable XFWM support
-
-    --with-gnome=<version>     build the theme for a specific Gnome version (3.14, 3.16, 3.18, 3.20)
-                               Note: Normally the correct version is detected automatically and this
-                               option should not be needed.
-
-After the installation is complete you can activate the theme with `gnome-tweak-tool` or a similar program by selecting `SolArc`, `SolArc-Darker` or `SolArc-Dark` as Window/GTK+ theme and `SolArc` or `SolArc-Dark` as Gnome-Shell and Xfce-Notify theme.
+    --disable-transparency         disable transparency in the GTK3 theme
+    --disable-light                disable Arc Light support
+    --disable-darker               disable Arc Darker support
+    --disable-dark                 disable Arc Dark support
+    --disable-cinnamon             disable Cinnamon support
+    --disable-gnome-shell          disable GNOME Shell support
+    --disable-gtk2                 disable GTK2 support
+    --disable-gtk3                 disable GTK3 support
+    --disable-metacity             disable Metacity support
+    --disable-unity                disable Unity support
+    --disable-xfwm                 disable XFWM support
+    --disable-plank                disable Plank theme support
+    --disable-openbox              disable Openbox support
+
+    --with-gnome-shell=<version>   build the gnome-shell theme for a specific version
+    --with-gtk3=<version>          build the GTK3 theme for a specific version
+                                   Note: Normally the correct version is detected automatically
+                                   and these options should not be needed.
+
+After the installation is complete the theme can be activated with `gnome-tweak-tool` or a similar program by selecting `SolArc`, `SolArc-Darker` or `SolArc-Dark` as Window/GTK+ theme and `SolArc` or `SolArc-Dark` as GNOME Shell/Cinnamon theme.
+
+If the `--disable-transparency` option was used, the theme will be installed as `SolArc-solid`, `SolArc-Darker-solid` and `SolArc-Dark-solid`.
 
 **Uninstall the theme**
 
 Run
 
     sudo make uninstall
 
-from the same directory as this README resides in, or
+from the patched Arc source directory, or
 
     sudo rm -rf /usr/share/themes/{SolArc,SolArc-Darker,SolArc-Dark}