numix-gtk-theme/README.md

88 lines
4.2 KiB
Markdown
Raw Normal View History

2016-04-23 06:24:18 +00:00
## Numix
2016-05-03 12:10:18 +00:00
##### A modern flat theme with a combination of light and dark elements. It supports GNOME, Unity, Xfce and Openbox.
2017-10-05 15:27:02 +00:00
[![By The Numix Project](https://img.shields.io/badge/By-The%20Numix%20Project-f0544c.svg?style=flat-square)](https://numixproject.org/)  [![Circle CI](https://img.shields.io/circleci/project/numixproject/numix-gtk-theme/master.svg?circle-token=b14acf911433d315298235b0c2fbf7b2670a92a8&maxAge=3600&style=flat-square)](https://circleci.com/gh/numixproject/numix-gtk-theme/tree/master)  [![GitHub release](https://img.shields.io/github/release/numixproject/numix-gtk-theme.svg?maxAge=3600&style=flat-square)](https://github.com/numixproject/numix-gtk-theme/releases/latest)  ![Supports GTK+ 3.18](https://img.shields.io/badge/GTK%2B-3.18-4a90d9.svg?style=flat-square)  ![Supports GTK+ 3.24](https://img.shields.io/badge/GTK%2B-3.24-4a90d9.svg?style=flat-square)
2014-01-06 20:49:27 +00:00
2016-10-01 23:53:38 +00:00
## Install It
2017-03-21 06:22:27 +00:00
### Distro Packages
2016-10-01 23:53:38 +00:00
|Distro|Install Command/Links|
|:----:|:----:|
|![arch][arch]  ![antergos][antergos]|`sudo pacman -S numix-gtk-theme`|
2017-03-21 06:22:27 +00:00
|![opensuse][opensuse]|[1 Click Install](http://software.opensuse.org/ymp/openSUSE:Factory/standard/numix-gtk-theme.ymp)  \|  [OBS Repo](http://software.opensuse.org/download.html?project=openSUSE%3AFactory&package=numix-gtk-theme)|
|![fedora][fedora]|`sudo dnf install numix-gtk-theme`|
|![debian][debian]  ![ubuntu][ubuntu]|`sudo apt install numix-gtk-theme`|
2016-10-01 23:53:38 +00:00
## Build It
2013-08-09 21:02:24 +00:00
2015-08-06 21:22:27 +00:00
First, you need to compile the theme using the [Sass](http://sass-lang.com/) compiler.
To install Sass, install Ruby and the gem command using your distribution's package manager. Then install `sass` with the `gem` command,
2015-08-06 21:22:27 +00:00
2017-10-14 08:19:06 +00:00
`gem install sass` (not needed for Ubuntu/Debian)
2015-08-06 21:22:27 +00:00
You'll also need the ```glib-compile-schemas``` and ```gdk-pixbuf-pixdata``` commands in your path to generate the gresource binary. Install them using your distribution's package manager.
2015-08-06 21:22:27 +00:00
2017-03-21 06:22:27 +00:00
|Distro|Commands|
|:----:|:----:|
|![arch][arch]  ![antergos][antergos]|`sudo pacman -S glib2 gdk-pixbuf2`|
|![opensuse][opensuse]|`sudo zypper install glib2-devel gdk-pixbuf-devel`|
2017-03-21 06:22:27 +00:00
|![fedora][fedora]|`sudo dnf install glib2-devel gdk-pixbuf2-devel`|
2017-10-14 08:19:06 +00:00
|![debian][debian]  ![ubuntu][ubuntu]|`sudo apt-get install ruby-sass libglib2.0-dev libgdk-pixbuf2.0-dev libxml2-utils`|
2015-08-06 21:22:27 +00:00
2017-03-21 06:22:27 +00:00
After installing all the dependencies, change to the cloned directory and, run the following in Terminal,
2015-08-06 21:22:27 +00:00
2015-09-09 19:05:36 +00:00
```sh
2015-08-06 21:22:27 +00:00
sudo make install
```
2013-08-09 21:02:24 +00:00
2016-05-03 12:10:18 +00:00
To set the theme in GNOME, run the following commands in Terminal,
2013-08-09 21:02:24 +00:00
2015-09-09 19:05:36 +00:00
```sh
2013-08-09 21:02:24 +00:00
gsettings set org.gnome.desktop.interface gtk-theme "Numix"
gsettings set org.gnome.desktop.wm.preferences theme "Numix"
```
2013-08-09 21:12:33 +00:00
To set the theme in Xfce, run the following commands in Terminal,
2015-09-09 19:05:36 +00:00
```sh
2013-08-09 21:12:33 +00:00
xfconf-query -c xsettings -p /Net/ThemeName -s "Numix"
2013-08-11 01:19:48 +00:00
xfconf-query -c xfwm4 -p /general/theme -s "Numix"
2013-08-09 21:12:33 +00:00
```
In Openbox you can set the theme with [ObConf](http://openbox.org/wiki/ObConf:About) tool. Alternatively, you can set the theme by changing the `<name> `key value to `Numix` in the `<theme>` section of your rc.xml file.
2016-04-23 06:24:18 +00:00
### For contributors
Start by reviewing the [guidelines for contributing](https://github.com/numixproject/numix-gtk-theme/blob/master/.github/CONTRIBUTING.md).
2015-09-09 19:05:36 +00:00
2016-04-23 06:24:18 +00:00
#### For developers
2015-09-09 19:05:36 +00:00
If you want to hack on the theme, make sure you have the `inotifywait` command available, which is used for watching and automatically building the files.
To start watching for changes, run the following,
```sh
make watch
```
If you change any assets, you'll need to regenerate the `gtk.gresource.xml` and `gtk.gresource` files. You can use [grrr](https://github.com/satya164/grrr) to do it easily.
2013-08-09 21:06:49 +00:00
### Requirements
2013-08-09 21:02:24 +00:00
GTK+ 3.18 or above
2013-08-09 21:12:33 +00:00
2013-08-09 21:02:24 +00:00
Murrine theme engine
2013-08-09 21:06:49 +00:00
### Code and license
2013-08-09 21:02:24 +00:00
2016-04-18 20:16:57 +00:00
Report bugs or contribute at [GitHub](https://github.com/numixproject/numix-gtk-theme)
2013-08-09 21:02:24 +00:00
License: GPL-3.0+
2017-03-21 06:22:27 +00:00
[antergos]: https://antergos.com/distro-logos/logo-square26x26.png "antergos"
[arch]: https://antergos.com/distro-logos/archlogo26x26.png "arch"
[fedora]: https://antergos.com/distro-logos/fedora-logo.png "fedora"
[openSUSE]: https://antergos.com/distro-logos/Geeko-button-bling7.png "openSUSE"
[ubuntu]: https://antergos.com/distro-logos/ubuntu_orange_hex.png "ubuntu"
[debian]: https://antergos.com/distro-logos/openlogo-nd-25.png "debian"
2017-03-21 06:22:27 +00:00