readme: add project description

shagu · May 13, 2021 · 7860e3e · 7860e3e
1 parent 815d914
commit 7860e3e
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# yada-gtk
+
+yada-gtk (yet another dark arc-theme) is yet another dark theme for GTK2 and GTK3 based on 
+[Arc-Theme](https://github.com/jnsh/arc-theme). Yada-GTK is not really a theme on its own, 
+but rather a script that, replaces the default colors to a more monochrome and dark ambiance.
+
+The latest build can be found at the [Release Page](https://github.com/shagu/yada-gtk-theme/releases).
+
+To adjust the colors to your likings and build your own, please follow the Arc-Theme build instructions 
+to install all dependencies. You can then modify and run the `./build.sh` in this repository.
+
+
+## Screenshots
+
+![preview1](preview1.png)
+*AwesomeWM, Alacritty, Thunar, Engrampa, Mousepad, [dotfiles](https://github.com/shagu/dotfiles)*
+
+![preview1](preview2.png)
+*AwesomeWM, Alacritty, VS-Code, Eye of Mate, [dotfiles](https://github.com/shagu/dotfiles)*
diff --git a/preview1.png b/preview1.png
diff --git a/preview2.png b/preview2.png