aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md147
1 files changed, 62 insertions, 85 deletions
diff --git a/README.md b/README.md
index 1630541..fd33639 100644
--- a/README.md
+++ b/README.md
@@ -1,76 +1,76 @@
-# Arc Theme
+# 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.
-Arc 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 fork of the Arc theme: https://github.com/horst3180/arc-theme
-## Arc is available in three variants
+Colours are based on the Solarized colour scheme by [Ethan Schoonover](https://github.com/altercation): https://github.com/altercation/solarized
-##### Arc
+Most of the work is done inside [solarize.sh](https://github.com/apheleia/solarc-theme/blob/master/solarize.sh), which replaces various Arc colours with matching Solarized colours.
-![A screenshot of the Arc theme](http://i.imgur.com/Ph5ObOa.png)
+## SolArc is available in three variants
+### SolArc
+![A screenshot of the Arc theme](https://github.com/apheleia/solarc-theme/blob/master/images/preview-light.png?raw=true)
-##### Arc-Darker
+### SolArc-Darker
+![A screenshot of the Arc-Darker theme](https://github.com/apheleia/solarc-theme/blob/master/images/preview-darker.png?raw=true)
-![A screenshot of the Arc-Darker theme](http://i.imgur.com/NC6dqyl.png)
+### SolArc-Dark
+![A screenshot of the Arc-Dark theme](https://github.com/apheleia/solarc-theme/blob/master/images/preview-dark.png?raw=true)
-##### Arc-Dark
-![A screenshot of the Arc-Dark theme](http://i.imgur.com/5AGlCnA.png)
-
-## Installation
-
-### Packages
+## 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)
-|Distro|Package Name/Link|
-|:----:|:----:|
-| Arch Linux | `arc-gtk-theme`, [`gtk-theme-arc-git`](https://aur.archlinux.org/packages/gtk-theme-arc-git) (AUR) |
-| Debian 8 | [OBS Repo][obs-repo] |
-| Debian Testing/Unstable | `arc-theme` |
-| Fedora 21 - 23 | [OBS Repo][obs-repo] |
-| Fedora 24 -25 | `arc-theme` |
-| Gentoo/Funtoo | `x11-themes/arc-theme` from the [Scriptkitties Overlay][sk-overlay] |
-| openSUSE | [OBS Repo][obs-repo] |
-| Solus | `arc-gtk-theme` |
-| Ubuntu 15.04 - 16.04 | [OBS Repo][obs-repo] |
-| Ubuntu 16.10 | `arc-theme` |
+Main distributions that meet these requirements are
-**elementary OS Note:** elementary OS Freya users can install the package for Ubuntu 15.04, Loki users can install the package for Ubuntu 16.04.
+* 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
-**AUR Note:** If you're having trouble with the AUR packages please email the package maintainer at zach@zach-adams.com before creating an issue.
+Derivatives of these distributions should work, as well.
-A non-transparent version of the theme is available here: [Arc Solid OBS repo](http://software.opensuse.org/download.html?project=home%3AHorst3180&package=arc-theme-solid)
+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/)
### Manual Installation
+**Important:** Remove all older versions of the theme from your system before you proceed any further.
-To build the theme the follwing packages are required
+ sudo rm -rf /usr/share/themes/{SolArc,SolArc-Darker,SolArc-Dark}
+ 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
* `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
-**Note:** If your distribution doesn't ship separate development packages you just need GTK 3 instead of the `-dev` packages.
-
-For the theme to function properly, install the following
-* GNOME Shell, GTK 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)
+If your distributions doesn't ship separate development packages you just need GTK 3 instead of the `-dev` packages.
Install the theme with the following commands
-#### 1. Get the source
+**1. Get the source**
-Clone the git repository with
+If you want to install the latest version from git, clone the repository with
- git clone https://github.com/horst3180/arc-theme --depth 1 && cd arc-theme
+ git clone https://github.com/apheleia/solarc-theme --depth 1 && cd solarc-theme
-#### 2. Build and install the theme
+**2. Build and install the theme**
./autogen.sh --prefix=/usr
sudo make install
@@ -78,9 +78,9 @@ Clone the git repository with
Other options to pass to autogen.sh are
--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-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
@@ -89,47 +89,28 @@ Other options to pass to autogen.sh are
--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)
+ --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 `Arc`, `Arc-Darker` or `Arc-Dark` as Window/GTK+ theme and `Arc` or `Arc-Dark` as GNOME Shell/Cinnamon theme.
+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.
-## Uninstall
+**Uninstall the theme**
Run
sudo make uninstall
-from the cloned git repository, or
-
- sudo rm -rf /usr/share/themes/{Arc,Arc-Darker,Arc-Dark}
-
-## Extras
+from the same directory as this README resides in, or
-### Arc KDE
-A port of Arc for the Plasma 5 desktop with a few additions and extras. Available [here](https://github.com/PapirusDevelopmentTeam/arc-kde).
+ sudo rm -rf /usr/share/themes/{SolArc,SolArc-Darker,SolArc-Dark}
-### Arc Firefox theme
-A theme for Firefox is available at https://github.com/horst3180/arc-firefox-theme
-
-### Arc icon theme
-The Arc icon theme is available at https://github.com/horst3180/arc-icon-theme
-
-### Chrome/Chromium theme
-To install the Chrome/Chromium theme go to the `extra/Chrome` folder and drag and drop the arc-theme.crx or arc-dark-theme.crx file into the Chrome/Chromium window. The source of the Chrome themes is located in the source "Chrome/arc-theme" folder.
-
-### Plank theme
-To install the Plank theme, copy the `extra/Arc-Plank` folder to `~/.local/share/plank/themes` or to `/usr/share/plank/themes` for system-wide use.
-Now open the Plank preferences window by executing `plank --preferences` from a terminal and select `Arc-Plank` as the theme.
-
-### Arc-Dark for Ubuntu Software Center
-The Arc Dark theme for the Ubuntu Software Center by [mervick](https://github.com/mervick) can be installed from [here](https://github.com/mervick/arc-dark-software-center). It solves readability issues with Arc Dark and the Ubuntu Software Center.
+## Contributing
+Every contribution is very welcome! Please create an issue and/or a pull request.
## Troubleshooting
-
-If you have Ubuntu with a newer GTK/GNOME version than the one included by default (i.e Ubuntu 14.04 with GTK 3.14 or Ubuntu 15.04 with GTK 3.16, etc.) the prebuilt packages won't work properly and you have to install the theme manually as described above.
-This is also true for other distros with a different GTK/GNOME version than the one included by default
+If you have Ubuntu with a newer GTK/Gnome version than the one included by default (i.e Ubuntu 14.04 with GTK 3.14 or Ubuntu 15.04 with GTK 3.16, etc.) the prebuilt packages won't work properly and you have to install the theme manually as described above.
+This is also true for other distros with a different GTK/Gnome version than the one included by default
--
@@ -137,16 +118,12 @@ If you get artifacts like black or invisible backgrounds under Unity, disable ov
gsettings set com.canonical.desktop.interface scrollbar-mode normal
-
-## Bugs
-If you find a bug, please report it at https://github.com/horst3180/arc-theme/issues
+## Bug reporting
+If you find a bug, please report it at https://github.com/apheleia/solarc-theme/issues
## License
-Arc is available under the terms of the GPL-3.0. See `COPYING` for details.
+SolArc is available under the terms of the GPL-3.0. See `COPYING` for details.
## Full Preview
-![A full screenshot of the Arc theme](http://i.imgur.com/tD1OBQ3.png)
-<sub>Screenshot Details: Icons: [Arc](https://github.com/horst3180/arc-icon-theme) | Launcher Icons based on [White Pixel Icons](http://darkdawg.deviantart.com/art/White-Pixel-Icons-252310560) | [Wallpaper](https://pixabay.com/photo-869593/) | Font: Futura Bk bt</sub>
-
-[obs-repo]: http://software.opensuse.org/download.html?project=home%3AHorst3180&package=arc-theme
-[sk-overlay]: https://c.darenet.org/scriptkitties/overlay
+![A full screenshot of the SolArc theme](https://github.com/apheleia/solarc-theme/blob/master/images/preview-complete.png?raw=true)
+<sub>Screenshot Details: Icons: [Arc Icon Theme](https://github.com/horst3180/arc-icon-theme) | Wallpaper: [Jason Levesque](http://stuntkid.com/) | Font: [DejaVu Sans](http://dejavu-fonts.org/wiki/Main_Page)</sub>