Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
peterychuang committed Sep 22, 2016
1 parent b5c205c commit 5d1d097
Showing 1 changed file with 37 additions and 76 deletions.
113 changes: 37 additions & 76 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,106 +1,67 @@
Flat-Plat
=========
A Material Design-like theme for GNOME/GTK+ based desktop environments.
Flat-Plat-Blue
==============
A Material Design-like flat theme for GTK3, GTK2, and GNOME Shell.
This is a fork of [Flat-Plat Theme](https://github.com/nana-4/Flat-Plat), but with the pinkish colours changed to blue.
In addition, I have also made a following changes to suit my own taste:
* Transparent top bar
* Font changed to Open Sans
* Changed colour for running apps dots.

Features
--------
<img src="img/Button.gif" alt="Button" align="right" />
* Supports ripple effect animations (only GTK3 apps).
* Supports both light and dark variants.
* Supports [Dash to Dock](https://github.com/micheleg/dash-to-dock) extension's theming.
* Supports [Workspaces to Dock](https://github.com/passingthru67/workspaces-to-dock) extension's theming.
* Supports Chrome/Chromium theme and scrollbars extensions.
* Appears more beautifully when you use a font family including `Medium` and `Light` weights.
* Supports [Dash to Dock](https://micheleg.github.io/dash-to-dock/) extension's theming.
* Appears more beautiful when you use a font family that including `Medium` and `Light` weight.

Requirements
------------
* GTK+ 3.14, 3.16, 3.18, 3.20 or 3.22
* `gnome-themes-standard`
* pixmap (or pixbuf) engine
* murrine engine
* GNOME/GTK+ 3.20 (I have only tested on 3.20)
* The `gnome-themes-standard` package for GTK2
* The pixmap (or pixbuf) engine for GTK2

##### Supported desktop environments are:
* GNOME Shell 3.14, 3.16, 3.18, 3.20 or 3.22
* Unity 7.4 (Ubuntu 16.04)
* Budgie 10.2.5 or later
* MATE 1.14 or later
> _If default Adwaita works fine, it should also works fine._
Installation
------------
1. Download an archive.
* [v3.22.20160921](https://github.com/nana-4/Flat-Plat/releases/download/v3.22.20160921/Flat-Plat-3.22.20160921.tar.gz) for GNOME 3.22
* [v3.22.20160921](https://github.com/nana-4/Flat-Plat/releases/download/v3.22.20160921/Flat-Plat-laptop-3.22.20160921.tar.gz) for GNOME 3.22 and small resolution
* [v3.20.20160921](https://github.com/nana-4/Flat-Plat/releases/download/v3.20.20160921/Flat-Plat-3.20.20160921.tar.gz) for GNOME 3.20, Budgie 10.2.x or MATE 1.14
* [v3.20.20160921](https://github.com/nana-4/Flat-Plat/releases/download/v3.20.20160921/Flat-Plat-laptop-3.20.20160921.tar.gz) for GNOME 3.20, Budgie 10.2.x or MATE 1.14 and small resolution
* [v3.18.20160921](https://github.com/nana-4/Flat-Plat/releases/download/v3.18.20160921/Flat-Plat-3.18.20160921.tar.gz) for GNOME 3.18 or Unity 7.4 (Ubuntu 16.04)
* [v3.16.20160821](https://github.com/nana-4/Flat-Plat/releases/download/v3.16.20160821/Flat-Plat-3.16.20160821.tar.gz) for GNOME 3.16
* [v3.14.20160921](https://github.com/nana-4/Flat-Plat/releases/download/v3.14.20160921/Flat-Plat-3.14.20160921.tar.gz) for GNOME 3.14
2. Extract it to the theme directory.
1. Download a archive.
* [3.20.20160411](https://github.com/peterychuang/Flat-Plat-Blue/releases/download/20160411/Flat-Plat-Blue-20160411.tar.gz) for GNOME 3.20
2. Extract it to the themes directory.
* For system-wide installation to `/usr/share/themes`
* For user-specific installation to `~/.themes`
3. Select the theme via `gnome-tweak-tool` or `unity-tweak-tool`.
4. [Optional] Set the font size to 10.5 (=14px) or 9.75 (=13px).
5. [Optional] Open the `chrome` folder and drag and drop the `.crx` files onto the Chrome/Chromium extensions page (`chrome://extensions/`).

#### Note if you want to clone from the repository
The `master` branch is currently being built for GNOME 3.22.
If you want to use [other versions](https://github.com/nana-4/Flat-Plat/branches/all), you need to specify the branch as follows:

git clone -b 3.18 https://github.com/nana-4/Flat-Plat.git
3. Use `gnome-tweak-tool` to change the theme.

GDM (Lock/Login Screen)
-----------------------
You can change the GDM theme by rewriting a system file.
But please **be careful** because if it fails, the desktop environment may not operate correctly.
------------------------------
To change the GDM theme, you need to rewrite a system file.
Please **be careful** because if it fails, desktop environment may not operate correctly.
> **Notes:**
> * When applying this, other GNOME Shell themes might look broken.
> * If GNOME Shell has been updated, you will need to install again.
> * Not supported for GNOME 3.14.
> * Not supported for GNOME 3.14, sorry.
> * When applying this, other shell themes might look broken.
### Install
1. Backup the existing `.gresource` file. _(Skip this step if you just update it.)_
1. Backup an existing .gresource file. _(Skip this step when you just update it.)_

sudo cp /usr/share/gnome-shell/gnome-shell-theme.gresource /usr/share/gnome-shell/gnome-shell-theme.gresource~
2. Replace with the new one.
* If you put this theme in `/usr/share/themes`:

sudo cp -i /usr/share/gnome-shell/gnome-shell-theme.gresource /usr/share/gnome-shell/gnome-shell-theme.gresource~
2. Replace it with the new one.
sudo cp /usr/share/themes/Flat-Plat/gnome-shell/gnome-shell-theme.gresource /usr/share/gnome-shell
* If you put this theme in `~/.themes`:

cd /usr/share/themes/Flat-Plat || cd ~/.themes/Flat-Plat
sudo cp -div gnome-shell/gnome-shell-theme.gresource /usr/share/gnome-shell
sudo cp ~/.themes/Flat-Plat/gnome-shell/gnome-shell-theme.gresource /usr/share/gnome-shell
3. Restart GNOME Shell (press `Alt`+`F2`, then type `r`).

### Uninstall
1. Restore to original theme from the backup.

sudo mv -iv /usr/share/gnome-shell/gnome-shell-theme.gresource~ /usr/share/gnome-shell/gnome-shell-theme.gresource
sudo mv -f /usr/share/gnome-shell/gnome-shell-theme.gresource~ /usr/share/gnome-shell/gnome-shell-theme.gresource
2. Restart GNOME Shell (press `Alt`+`F2`, then type `r`).

Screenshots
-----------
##### GNOME Shell 3.20
![GNOME Shell 3.20](img/Screenshot1.png?raw=true)
##### Unity 7.4
![Unity 7.4](img/Screenshot2.png?raw=true)
##### GDM Lock Screen
![GDM Lock Screen](img/Screenshot3.png?raw=true)
##### GDM Unlock Screen
![GDM Unlock Screen](img/Screenshot4.png?raw=true)
<sub>**Screenshots Details:** Icons: [Paper](https://github.com/snwh/paper-icon-theme) | Font: [M+ 1C](https://mplus-fonts.osdn.jp/) 10.5pt | Dock's icon size: 48px + fixed | [Wallpapers](http://imgur.com/a/v2Ovx)</sub>

Bug Reporting
-------------
If you find a bug, please report it here: https://github.com/nana-4/Flat-Plat/issues

Planned Features
----------------
* Supports of global dark theme
* Supports of Xfce theme
* Supports of Firefox theme
* Supports of overlay scrollbars for Chrome/Chromium extension
* GNOME Terminal color pallet (if possible)
* Material Design like cursor theme

License
-------
Flat-Plat is available under the terms of the GPL. See the `COPYING` file for details.
> **Notes:**
> * Included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
> * Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
Other Info
----------
* License: GPL
* Chrome's scrollbars extension forked from [Adwaita Scrollbars](https://github.com/gnome-integration-team/chrome-gnome-scrollbar). Thanks for original author.
* Forked by [Peter Y. Chuang - Novelist](https://novelist.xyz)

0 comments on commit 5d1d097

Please sign in to comment.