Large update. See: #143

Author: lassekongo83

.gitattributes

@@ -1,4 +1,4 @@
-.gitattributes export-ignore  
-.gitignore export-ignore
-zukitre.png export-ignore
+.gitattributes export-ignore
+.github export-ignore
 zukitwo.png export-ignore
+zukitre.png export-ignore

.gitignore

@@ -1,7 +1,5 @@
 # Ignore Backup Copies from Text Editor
 *~
 
-# Ignore SASS files
-.sass-cache
-gtk.gresource
-dist
+# Ignore meson build directory
+build

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+## Contributing to Zuki-themes
+
+Zuki-themes consists of:
+
+* `gnome-shell` is the theme for GNOME Shell. This themes stuff like the calendar widget, the panel, the dock and more.
+* `gtk-2.0` contains the GTK+2 theme, styling applications that doesn't use GTK+3 yet.
+* `gtk-3.0` contains the GTK+3 theme, styling most modern GTK+ applications.
+* `xfwm4` contains the theme that styles the xfwm4 window manager for XFCE4.
+
+### Build and install themes from source
+
+```bash
+# Download the repository from github
+git clone https://github.com/lassekongo83/zuki-themes.git
+cd zuki-themes
+# Initialize build system (only required once per repo)
+meson build
+# Build and install
+sudo ninja -C build install
+```
+
+### More granular changes
+
+Now everything should be in place. Select a GTK theme via:
+```bash
+gsettings set org.gnome.desktop.interface gtk-theme Zukitre
+```
+
+The available themes will be installed in `/usr/share/themes`. You can edit the `gtk.css` and `gnome-shell.css` files in those folders directly for testing, or you can edit the SCSS files inside the folder you cloned from GitHub.
+
+SCSS is the actual "source code" of the theme. This is compiled into the CSS files. Edit the SCSS if you want to contribute your changes back here. SCSS is simple enough to get the hang of if you already know CSS. You can go through [this SCSS tutorial](http://marksheet.io/sass-scss-less.html) to learn more. After making your edits in the SCSS files, you can run `sudo ninja install` in the `zuki-themes/build` folder. That’ll do all the compiling and installing.
+
+Changes to the GNOME Shell theme are visible after doing <kbd>Alt</kbd> + <kbd>F2</kbd> and running `rt` as command. The changes to the GTK theme will be visible after running the following commands.
+
+```bash
+# To reload GTK theme
+# Change to Adwaita theme and back to Zukitre
+gsettings set org.gnome.desktop.interface gtk-theme Adwaita
+gsettings set org.gnome.desktop.interface gtk-theme Zukitre
+```
+
+The files named `assets.svg` and `assets.txt` contains some images used in the themes.
+If you change anything in `assets.svg` you'll have to make sure that the Object ID in inkscape is kept intact. Any new Object ID created must be added to `assets.txt`. Then run `render-assets.sh` to generate the new images. Changed images will have to be removed before running `render-assets.sh`.

LICENSE

@@ -1,7 +1,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -631,8 +631,8 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    {one line to give the program's name and a brief idea of what it does.}
-    Copyright (C) {year}  {name of author}
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -645,14 +645,14 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    {project}  Copyright (C) {year}  {fullname}
+    <program>  Copyright (C) <year>  <name of author>
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
@@ -664,11 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,72 +1,58 @@
-# Zuki Themes
+# zuki-themes
+Themes for GNOME and XFCE4.
 
-Zuki themes for GNOME, Xfce and more.
+![Zukitre](zukitre.png?raw=true)
+<sub>[Wallpapers](https://imgur.com/a/zrijHvk) | [Icons](https://github.com/vinceliuice/Tela-icon-theme) | Fonts: Roboto / SF Mono | GNOME shell extension: Dash to Panel</sub>
 
-##### Zukitre
+![Zukitwo](zukitwo.png?raw=true)
+<sub>[Wallpapers](https://imgur.com/a/zrijHvk) | [Icons](https://github.com/vinceliuice/Tela-icon-theme) | Fonts: Roboto / SF Mono | GNOME shell extension: Dash to Panel</sub>
 
-![Zukitre theme](zukitre.png?raw=true)
+### Requirements
 
-##### Zukitwo
+- GNOME Shell 3.30+
+- GTK 3.24.6+
 
-![Zukitwo theme](zukitwo.png?raw=true)
+<sub>The themes should work on some older versions. I just can't guarantee that the themes will look as intended on older versions.</sub>
 
-<sub>Screenshot Details: [Wallpaper](http://mustberesult.deviantart.com/art/Almora-212657321) | [Icons](https://github.com/numixproject/numix-icon-theme-circle) | GNOME shell extensions: Dash to dock, Hide top bar. | Clock: [tint2](https://gist.github.com/lassekongo83/d9c432457599c4633280423c6a77c7be)</sub>
+Some of these packages may already be installed by default on some distros.
 
-## Requirements
+* Debian/Ubuntu/Mint - `apt install gtk2-engines-murrine gtk2-engines-pixbuf fonts-roboto ninja-build git meson sassc`
+* Arch/Manjaro/Antergos - `pacman -S gtk-engine-murrine gtk-engines ttf-roboto ninja git meson sassc`
+* Opensuse - `zypper in gtk2-engine-murrine gtk2-engines google-roboto-fonts ninja git meson sassc`
+* Fedora - `dnf install gtk-murrine-engine gtk2-engines google-roboto-fonts ninja-build git meson sassc`
 
-The master branch should work with GTK 3.22+.
-
-* GNOME/GTK 3.18 - 3.22+
-* The murrine engine. This has different names depending on your distro.
-  * `gtk2-engines-murrine` (Debian, Ubuntu)
-  * `gtk-murrine-engine` (Fedora)
-  * `gtk-engine-murrine` (ArchLinux)
-* The pixbuf engine. This has different names depending on your distro.
-  * `gtk2-engines-pixbuf` (Debian, Ubuntu)
-  * `gtk2-engines` (Fedora)
-  * `gtk-engines` (ArchLinux)
-
-##### Optional recommended requirements
-* Roboto fonts (For the GNOME shell theme.)
-  * `fonts-roboto` (Debian, Ubuntu)
-  * `google-roboto-fonts` (Fedora)
-  * `ttf-roboto` (ArchLinux AUR)
+Other distros may have named the above packages differently.
 
 ## Installation
 
-#### Manual installation
-
-Download the theme:
-  * [GTK 3.22 or later](https://github.com/lassekongo83/zuki-themes/archive/master.zip) (Master branch.)
-  * [GTK 3.18](https://github.com/lassekongo83/zuki-themes/archive/3.18.zip) (Download this if you use X/Ubuntu 16.04.)
-
-Extract the contents in the zip to `~/.themes` or `/usr/share/themes` with the following folder structure:
-
-`Zukitre`
-
-  * `gtk-3.0`
-  * `gtk-2.0`
-  * `xfwm4`
-
-`Zuki-shell`
-
-  * `gnome-shell`
-
-etc.
+When the above requirements are installed, simply run these commands:
+```bash
+git clone https://github.com/lassekongo83/zuki-themes.git
+cd zuki-themes
+meson build
+sudo ninja -C build install
+```
+The themes will be installed in: `/usr/share/themes`
 
-Apply the theme in `gnome-tweaks` or `dconf-editor`. Xfce users can apply it in `Settings > Appearance` and `Settings > Window manager`. If you wish to use the GNOME shell theme make sure the `User themes` extension is activated in `gnome-tweaks`.
+### Updating the theme
 
-#### Other installation options
+Navigate to the `zuki-themes` folder that was originally cloned. (If you removed it, do the steps above instead).
 
-ArchLinux users can get it on AUR: https://aur.archlinux.org/packages/zuki-themes-git/ (Not maintained by me!)
+Then simply run:
+```bash
+git pull
+sudo ninja -C build install
+```
 
-## Troubleshooting & Bug reporting
+#### Changing themes
 
-**The issue tracker is for provable issues only:** You will have to make the case that the issue is really with the theme and not something else on your side. To make a case means to provide detailed steps so that anybody can reproduce the issue. Be sure to rule out that the issue is not caused by something specific on your side.
+Use `gnome-tweaks` to change themes.
 
-**Required information:**
-> 1. Your GTK+ version/theme version/Linux distribution.
-> 1. Does the same issue occur with other themes?
-> 1. Screenshot. (Use a host that don't require me to enable JavaScript, cookies or browser plugins to be able to view the image.)
+You can also change your GTK themes using a terminal.
+```bash
+# Changing the theme to Zukitre-dark, simply run
+gsettings set org.gnome.desktop.interface gtk-theme Zukitre-dark
 
-**Do not submit support questions to the issue tracker.** Contact me on [reddit](https://www.reddit.com/user/Frellwit/) or [deviantART](http://lassekongo83.deviantart.com) for that instead. (Don't always expect an answer though.) Public forums and subreddits could provide better support. Support questions in the issue tracker will be closed as invalid.
+# Reverting the change to the default GNOME theme
+gsettings set org.gnome.desktop.interface gtk-theme Adwaita
+```