diff --git a/README.md b/README.md index dca67457c..1ae2645e0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ -# Flat-Plat -A Material Design-like flat theme for GTK3, GTK2, and GNOME-Shell. +Flat-Plat +========= +Button +A Material Design-like flat theme for GTK3, GTK2, and GNOME-Shell. +This theme requires GNOME 3.14 / 3.16 / 3.18, and doesn't work properly with other versions. + +Installation +------------ +1. Extract the archive to the themes directory (`/usr/share/themes` or `~/.themes`). +2. Use `gnome-tweak-tool` to change the theme. +3. Optionally, open the `chrome` folder and drag and drop the .crx files onto the Chrome's extensions page (`chrome://extensions/`). + +GDM (a.k.a. Login Screen) +------------------------- +**In order to apply this theme to the login screen, you need the following steps:** + +1. Backup and replace .gresource files. + + sudo cp -b /usr/share/themes/Flat-Plat/gnome-shell/gnome-shell-theme.gresource /usr/share/gnome-shell +2. Restart gnome shell (press `Alt`+`F2`, then type `r`). +3. Done! + +![GDM](img/GDM.png) + +**In order to restore original theme, type the following command:** + + sudo mv -f /usr/share/gnome-shell/gnome-shell-theme.gresource~ /usr/share/gnome-shell/gnome-shell-theme.gresource + +> **NOTE:** +> * **Be careful** if you experiment, as replacing system files could render your system unbootable. +> * When applying this, other shell themes might look broken. + +Screenshots +----------- +![Screenshot1](img/Screenshot1.png) +![Screenshot2](img/Screenshot2.png) +![Screenshot3](img/Screenshot3.png) + +Other Info +---------- +* Font: `M+ 1C` +http://mplus-fonts.sourceforge.jp/mplus-outline-fonts/index-en.html +* Reference color scheme: +http://flatuicolors.com/ +* License: GPLv3 diff --git a/img/Button.gif b/img/Button.gif new file mode 100644 index 000000000..386b17f8b Binary files /dev/null and b/img/Button.gif differ diff --git a/img/GDM.png b/img/GDM.png new file mode 100644 index 000000000..ee14ef726 Binary files /dev/null and b/img/GDM.png differ diff --git a/img/Screenshot1.png b/img/Screenshot1.png new file mode 100644 index 000000000..b81b9a068 Binary files /dev/null and b/img/Screenshot1.png differ diff --git a/img/Screenshot2.png b/img/Screenshot2.png new file mode 100644 index 000000000..9357d8c12 Binary files /dev/null and b/img/Screenshot2.png differ diff --git a/img/Screenshot3.png b/img/Screenshot3.png new file mode 100644 index 000000000..104510137 Binary files /dev/null and b/img/Screenshot3.png differ