initial commit

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100755
index 0000000..8dd118d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# shiki-colors-revival
+
+This consists mostly of a script that modifies the original Zukitwo-Brave-Brave-Brave-Brave-Brave-Brave theme's
+files to fit to all of the colors in the GNOME Colors palette.
+
+At the moment, these themes are currently intended to be used with Xfce4, since
+that's what I use. If you run into problems in another desktop environment,
+I'll try to help the best I can though.
+
+## Installing
+1. Open a terminal in this repo's directory.
+2. `./make-colors-themes generate`
+3. `./make-colors-themes install` or `./make-colors-themes user-install`
+
+Use `./make-colors-themes` if you want to know what else the installer can do.
+
+## Current problems
+- I'm still learning GTK, and GNOME developers, for some god-only-knows-why
+reason they decided to provide pretty awful documentation.
+- Eventually this will stop working since GNOME developers will probably think
+  that GTK 3 on non-GNOME environments is deprecated or something, and not worth
+  their support. It's probably better to use Qt in the future.
+- At the moment, the theme is (obviously) not a completely accurate recreation
+  of Shiki-Colors-Murrine. As of writing, the menubar color doesn't blend with
+  the titlebars yet, and the only things that match are the background colors
+  and the selected background colors. However, if you don't care about the
+  menubar color then you might feel this is good enough anyway.
+
+## Credits
+- Zuki-themes by [lassekongo83](http://lassekongo83.deviantart.com/)
+- Zukitwo-Brave-Brave-Brave-Brave-Brave-Brave-Colors-Xfwm by [fredbird67](http://xfce-look.org/usermanager/search.php?username=fredbird67)