numix-gtk-theme/README.md

## Numix
##### A modern flat theme with a combination of light and dark elements. It supports GNOME, Unity, Xfce and Openbox.
[![By The Numix Project](https://img.shields.io/badge/By-The%20Numix%20Project-f0544c.svg?style=flat-square)](https://numixproject.org/) &nbsp;[![Circle CI](https://img.shields.io/circleci/project/numixproject/numix-gtk-theme/master.svg?circle-token=b14acf911433d315298235b0c2fbf7b2670a92a8&maxAge=2592000&style=flat-square)](https://circleci.com/gh/numixproject/numix-gtk-theme/tree/master) &nbsp;[![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) &nbsp;![Supports GTK+ 3.18](https://img.shields.io/badge/GTK%2B-3.18-4a90d9.svg?style=flat-square) &nbsp;![Supports GTK+ 3.20](https://img.shields.io/badge/GTK%2B-3.20-4a90d9.svg?style=flat-square)

### Manual installation

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,

`gem install sass`

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.

#### Debian, Ubuntu

 ```sh
sudo apt-get install libglib2.0-dev libgdk-pixbuf2.0-dev libxml2-utils
```

#### Fedora

```sh
sudo dnf install glib2-devel gdk-pixbuf2-devel
```

#### Arch Linux

```sh
sudo pacman -S glib2 gdk-pixbuf2
```

After installing all the dependencies, switch to the cloned directory and, run the following in Terminal,

```sh
make
sudo make install
```

To set the theme in GNOME, run the following commands in Terminal,

```sh
gsettings set org.gnome.desktop.interface gtk-theme "Numix"
gsettings set org.gnome.desktop.wm.preferences theme "Numix"
```

To set the theme in Xfce, run the following commands in Terminal,

```sh
xfconf-query -c xsettings -p /Net/ThemeName -s "Numix"
xfconf-query -c xfwm4 -p /general/theme -s "Numix"
```

### For contributors
Start by reviewing the [guidelines for contributing](https://github.com/numixproject/numix-gtk-theme/blob/master/.github/CONTRIBUTING.md).

#### For developers
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.

### Requirements

GTK+ 3.18 or above

Murrine theme engine

### Code and license

Report bugs or contribute at [GitHub](https://github.com/numixproject/numix-gtk-theme)

License: GPL-3.0+
update readme 2016-04-23 06:24:18 +00:00			`## Numix`
Fixed capitalization, use https 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.`
Update README.md 2016-09-18 10:02:05 +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=2592000&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.20](https://img.shields.io/badge/GTK%2B-3.20-4a90d9.svg?style=flat-square)
Added website to README.md 2014-01-06 20:49:27 +00:00
Updated README 2013-08-09 21:06:49 +00:00			`### Manual installation`
Updated README 2013-08-09 21:02:24 +00:00
Update installation instructions 2015-08-06 21:22:27 +00:00			`First, you need to compile the theme using the [Sass](http://sass-lang.com/) compiler.`

Fixed issue spottted by @lots0logs (#405) 2016-05-04 08:31:00 +00:00			To install Sass, install Ruby and the gem command using your distribution's package manager. Then install `sass` with the `gem` command,
Update installation instructions 2015-08-06 21:22:27 +00:00
			`gem install sass`

Updating readme to specifically list package names. Fixes #555 & #493 * Updating readme to specifically list package names * Updating readme with dependency commands to run 2016-09-11 19:01:44 +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.
Update installation instructions 2015-08-06 21:22:27 +00:00
Updating readme to specifically list package names. Fixes #555 & #493 * Updating readme to specifically list package names * Updating readme with dependency commands to run 2016-09-11 19:01:44 +00:00			`#### Debian, Ubuntu`

			```sh
			`sudo apt-get install libglib2.0-dev libgdk-pixbuf2.0-dev libxml2-utils`
			```

			`#### Fedora`

			```sh
			`sudo dnf install glib2-devel gdk-pixbuf2-devel`
			```

			`#### Arch Linux`

			```sh
			`sudo pacman -S glib2 gdk-pixbuf2`
			```
Update installation instructions 2015-08-06 21:22:27 +00:00
			`After installing all the dependencies, switch to the cloned directory and, run the following in Terminal,`

Update the docs 2015-09-09 19:05:36 +00:00			```sh
Update installation instructions 2015-08-06 21:22:27 +00:00			`make`
			`sudo make install`
			```
Updated README 2013-08-09 21:02:24 +00:00
Fixed capitalization, use https 2016-05-03 12:10:18 +00:00			`To set the theme in GNOME, run the following commands in Terminal,`
Updated README 2013-08-09 21:02:24 +00:00
Update the docs 2015-09-09 19:05:36 +00:00			```sh
Updated README 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"`
			```

Updated README 2013-08-09 21:12:33 +00:00			`To set the theme in Xfce, run the following commands in Terminal,`

Update the docs 2015-09-09 19:05:36 +00:00			```sh
Updated README 2013-08-09 21:12:33 +00:00			`xfconf-query -c xsettings -p /Net/ThemeName -s "Numix"`
Improvements to GTK2 theme 2013-08-11 01:19:48 +00:00			`xfconf-query -c xfwm4 -p /general/theme -s "Numix"`
Updated README 2013-08-09 21:12:33 +00:00			```

update readme 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).`
Update the docs 2015-09-09 19:05:36 +00:00
update readme 2016-04-23 06:24:18 +00:00			`#### For developers`
Update the docs 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.

Updated README 2013-08-09 21:06:49 +00:00			`### Requirements`
Updated README 2013-08-09 21:02:24 +00:00
Drop support for Gtk-3.16 Styles for 3.18 also works for 3.16. From now on we don't expilicitly support Gtk-3.16 2016-07-19 19:07:58 +00:00			`GTK+ 3.18 or above`
Updated README 2013-08-09 21:12:33 +00:00
Updated README 2013-08-09 21:02:24 +00:00			`Murrine theme engine`

Updated README 2013-08-09 21:06:49 +00:00			`### Code and license`
Updated README 2013-08-09 21:02:24 +00:00
Fix link to issues page in README 2016-04-18 20:16:57 +00:00			`Report bugs or contribute at [GitHub](https://github.com/numixproject/numix-gtk-theme)`
Updated README 2013-08-09 21:02:24 +00:00
			`License: GPL-3.0+`