diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4fa7f66 --- /dev/null +++ b/README.md @@ -0,0 +1,85 @@ +## Librix + +Based in [Numix](https://github.com/numixproject/numix-gtk-theme) + +##### A modern flat theme with dark elements. It supports GNOME, Unity, Xfce and Openbox. +  + +## Install It + +## Build It + +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` (not needed for Ubuntu/Debian) + +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| +|:----:|:----:| +|![hyperbola][hyperbola] ![parabola][parabola] ![arch][arch]|`sudo pacman -S ruby glib2 gdk-pixbuf2`| +|![opensuse][opensuse]|`sudo zypper install glib2-devel gdk-pixbuf-devel`| +|![fedora][fedora]|`sudo dnf install glib2-devel gdk-pixbuf2-devel`| +|![trisquel][trisquel] ![debian][debian] ![ubuntu][ubuntu]|`sudo apt-get install ruby-sass 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 zip +``` + +or for install in global system: + +```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 "Librix" +gsettings set org.gnome.desktop.wm.preferences theme "Librix" +``` + +To set the theme in Xfce, run the following commands in Terminal, + +```sh +xfconf-query -c xsettings -p /Net/ThemeName -s "Librix" +xfconf-query -c xfwm4 -p /general/theme -s "Librix" +``` + +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 `Librix` in the `<theme>` section of your rc.xml file. + +#### 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 [LibreGit](https://libregit.org/heckyel/librix) + +License: GPL-3.0+ + +[hyperbola]: https://archive.org/download/libreweb/hyperbola.png "Hyperbola" +[parabola]: https://archive.org/download/libreweb/parabola.png "Parabola" +[arch]: https://archive.org/download/libreweb/arch.png "Arch" +[fedora]: https://archive.org/download/libreweb/fedora.png "Fedora" +[openSUSE]: https://archive.org/download/libreweb/opensuse.png "openSUSE" +[trisquel]: https://archive.org/download/libreweb/trisquel.png "Trisquel" +[ubuntu]: https://archive.org/download/libreweb/ubuntu.png "Ubuntu" +[debian]: https://archive.org/download/libreweb/debian.png "Debian" |