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=3600&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.24](https://img.shields.io/badge/GTK%2B-3.24-4a90d9.svg?style=flat-square)

## Install It

### Distro Packages
|Distro|Install Command/Links|
|:----:|:----:|
|![arch][arch] &nbsp;![antergos][antergos]|`sudo pacman -S numix-gtk-theme`|
|![opensuse][opensuse]|[1 Click Install](http://software.opensuse.org/ymp/openSUSE:Factory/standard/numix-gtk-theme.ymp) &nbsp;\|&nbsp; [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] &nbsp;![ubuntu][ubuntu]|`sudo apt install numix-gtk-theme`|

## Build It

First, you need to compile the theme using the [Sass](http://sass-lang.com/) compiler.

You will need to install SassC (`sassc`) which is likely to be available as a package in your distribution's software repositories.

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.

|Distro|Commands|
|:----:|:----:|
|![arch][arch] &nbsp;![antergos][antergos]|`sudo pacman -S sassc glib2 gdk-pixbuf2`|
|![opensuse][opensuse]|`sudo zypper install sassc glib2-devel gdk-pixbuf-devel`|
|![fedora][fedora]|`sudo dnf install sassc glib2-devel gdk-pixbuf2-devel`|
|![debian][debian] &nbsp;![ubuntu][ubuntu]|`sudo apt-get install sassc libglib2.0-dev libgdk-pixbuf2.0-dev libxml2-utils`|

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

```sh
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"
```

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.

### 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+


[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"
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 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)
Added website to README.md 2014-01-06 20:49:27 +00:00
Update README.md 2016-10-01 23:53:38 +00:00			`## Install It`

Update README.md 2017-03-21 06:22:27 +00:00			`### Distro Packages`
Update README.md 2016-10-01 23:53:38 +00:00			`\|Distro\|Install Command/Links\|`
			`\|:----:\|:----:\|`
README: update Arch package name (#663) Looking at https://www.archlinux.org/packages/?q=numix , I don't see any `numix-themes` package, but a `numix-gtk-theme` one. 2017-04-16 23:49:09 +00:00			\|![arch][arch]  ![antergos][antergos]\|`sudo pacman -S numix-gtk-theme`\|
Update README.md 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`\|
Update README.md 2016-10-01 23:53:38 +00:00
			`## Build It`
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.`

Replace deprecated Ruby Sass with SassC #734 (#740) * Update README.md with instructions to use SassC Updates the Build It instructions for using SassC instead of Ruby Sass * Updates Makefile to replace Ruby Sass with SassC This commit replaces the use of the Ruby Sass scss command with SassC's sassc command. Due to the more limited functionality of sassc, output directories must be created prior to running the command and only one file may be processed at a time unlike the many-to-many mode functionality of the scss command. * Makes import directive relative in _gnome-terminal.scss This commit changes the "widgets/button" import directive to be relative in the gtk-3.20 _gnome-terminal.scss file which is necessary when using SassC. * Removes import directive in _gnome-terminal.scss This commit removes the "widgets/button" import directive in the gtk-3.20 _gnome-terminal.scss file which is unnecessary. Co-authored-by: KTB <ktb83@users.noreply.github.com> 2020-07-12 07:40:33 +00:00			You will need to install SassC (`sassc`) which is likely to be available as a package in your distribution's software repositories.
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			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
Update README.md 2017-03-21 06:22:27 +00:00			`\|Distro\|Commands\|`
			`\|:----:\|:----:\|`
Replace deprecated Ruby Sass with SassC #734 (#740) * Update README.md with instructions to use SassC Updates the Build It instructions for using SassC instead of Ruby Sass * Updates Makefile to replace Ruby Sass with SassC This commit replaces the use of the Ruby Sass scss command with SassC's sassc command. Due to the more limited functionality of sassc, output directories must be created prior to running the command and only one file may be processed at a time unlike the many-to-many mode functionality of the scss command. * Makes import directive relative in _gnome-terminal.scss This commit changes the "widgets/button" import directive to be relative in the gtk-3.20 _gnome-terminal.scss file which is necessary when using SassC. * Removes import directive in _gnome-terminal.scss This commit removes the "widgets/button" import directive in the gtk-3.20 _gnome-terminal.scss file which is unnecessary. Co-authored-by: KTB <ktb83@users.noreply.github.com> 2020-07-12 07:40:33 +00:00			\|![arch][arch]  ![antergos][antergos]\|`sudo pacman -S sassc glib2 gdk-pixbuf2`\|
			\|![opensuse][opensuse]\|`sudo zypper install sassc glib2-devel gdk-pixbuf-devel`\|
			\|![fedora][fedora]\|`sudo dnf install sassc glib2-devel gdk-pixbuf2-devel`\|
			\|![debian][debian]  ![ubuntu][ubuntu]\|`sudo apt-get install sassc libglib2.0-dev libgdk-pixbuf2.0-dev libxml2-utils`\|
Update installation instructions 2015-08-06 21:22:27 +00:00
Update README.md 2017-03-21 06:22:27 +00:00			`After installing all the dependencies, change to the cloned directory and, run the following in Terminal,`
Update installation instructions 2015-08-06 21:22:27 +00:00
Update the docs 2015-09-09 19:05:36 +00:00			```sh
Update installation instructions 2015-08-06 21:22:27 +00:00			`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			```

Add instructions to README to set theme in Openbox. Fixes #692 Fixes #692 2018-01-15 06:24:35 +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.

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+`
Update README.md 2017-03-21 06:22:27 +00:00

Update urls for distro logo images in README.md 2017-10-05 15:23:02 +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"`
Update README.md 2017-03-21 06:22:27 +00:00