Update README.md

master
horst3180 2016-11-07 22:59:30 +01:00 committed by GitHub
parent a4936b7cdc
commit 59ee31e5b8
1 changed files with 58 additions and 82 deletions

140
README.md
View File

@ -2,24 +2,59 @@
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.
###Arc is available in three variants
## Arc is available in three variants
#####Arc
##### Arc
![A screenshot of the Arc theme](http://i.imgur.com/Ph5ObOa.png)
#####Arc-Darker
##### Arc-Darker
![A screenshot of the Arc-Darker theme](http://i.imgur.com/NC6dqyl.png)
#####Arc-Dark
##### Arc-Dark
![A screenshot of the Arc-Dark theme](http://i.imgur.com/5AGlCnA.png)
## Installation
### Requirements
### Packages
* Gnome/GTK3 3.14 - 3.22
|Distro|Package Name/Link|
|:----:|:----:|
| Arch Linux | `arc-gtk-theme`, [`arc-gtk-theme-git`](https://aur.archlinux.org/packages/gtk-theme-arc-git) (AUR) |
| Debian 8 | [OBS Repo](http://software.opensuse.org/download.html?project=home%3AHorst3180&package=arc-theme) |
| Debian Testing/Unstable | `arc-theme` |
| Fedora | [OBS Repo](http://software.opensuse.org/download.html?project=home%3AHorst3180&package=arc-theme) |
| Gentoo/Funtoo | `x11-themes/arc-theme` from the [Scriptkitties Overlay][sk-overlay] |
| Open SUSE | [OBS Repo](http://software.opensuse.org/download.html?project=home%3AHorst3180&package=arc-theme) |
| Solus | `arc-gtk-theme` |
| Ubuntu 15.04 - 16.04 | [OBS Repo](http://software.opensuse.org/download.html?project=home%3AHorst3180&package=arc-theme) |
| Ubuntu 16.10 | `arc-theme` |
**elementary OS Note:** elementary OS Freya users can install the package for Ubuntu 15.04, Loki user can install the package for Ubuntu 16.04
--
**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.
--
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)
### Manual Installation
To build the theme the follwing 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
**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)
@ -28,74 +63,15 @@ Arc is a flat theme with transparent elements for GTK 3, GTK 2 and Gnome-Shell w
* `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
**Important:** Remove all older versions of the theme from your system before you proceed any further.
sudo rm -rf /usr/share/themes/{Arc,Arc-Darker,Arc-Dark}
rm -rf ~/.local/share/themes/{Arc,Arc-Darker,Arc-Dark}
rm -rf ~/.themes/{Arc,Arc-Darker,Arc-Dark}
#### Packages
Prebuilt packages for Ubuntu, Debian, Fedora and openSUSE are available at
http://software.opensuse.org/download.html?project=home%3AHorst3180&package=arc-theme
A non-transparent version of the theme is available here
http://software.opensuse.org/download.html?project=home%3AHorst3180&package=arc-theme-solid
**Note:** elementary OS Freya users can install the package for Ubuntu 15.04, Loki user can install the package for Ubuntu 16.04
--
Arch Linux users can install the official releases directly from pacman in the Community repo and development releases in the AUR
**Official Releases**: [arc-gtk-theme](https://www.archlinux.org/packages/community/any/arc-gtk-theme/)
**Development Releases (AUR)**: [gtk-theme-arc-git](https://aur.archlinux.org/packages/gtk-theme-arc-git/)
**Note:** If you're having trouble with the AUR packages please email the package maintainer at zach@zach-adams.com before creating an issue.
--
Gentoo/Funtoo users can install `x11-themes/arc-theme` from the [Scriptkitties Overlay][sk-overlay].
--
#### Manual Installation
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
If your distribution 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
If you want to install the latest version from git, clone the repository with
Clone the git repository with
git clone https://github.com/horst3180/arc-theme --depth 1 && cd arc-theme
**2. Build and install the theme**
#### 2. Build and install the theme
./autogen.sh --prefix=/usr
sudo make install
@ -118,37 +94,37 @@ Other options to pass to autogen.sh are
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 and Xfce-Notify theme.
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.
**Uninstall the theme**
## Uninstall
Run
sudo make uninstall
from the same directory as this README resides in, or
from the cloned git repository, or
sudo rm -rf /usr/share/themes/{Arc,Arc-Darker,Arc-Dark}
### Extras
## Extras
#### Arc Firefox theme
### Arc Firefox theme
A theme for Firefox is available at https://github.com/horst3180/arc-firefox-theme
#### Arc icon theme
### Arc icon theme
The Arc icon theme is available at https://github.com/horst3180/arc-icon-theme
#### Chrome/Chromium 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
### 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
### 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.
### Troubleshooting
## 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
@ -160,13 +136,13 @@ If you get artifacts like black or invisible backgrounds under Unity, disable ov
gsettings set com.canonical.desktop.interface scrollbar-mode normal
### Bugs
## Bugs
If you find a bug, please report it at https://github.com/horst3180/arc-theme/issues
### License
Arc is available under the terms the GPL-3.0. See `COPYING` for details.
## License
Arc is available under the terms of the GPL-3.0. See `COPYING` for details.
### Full Preview
## 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>