luisgulo/WhiteSur-gtk-theme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme.

Browse Source
This commit is contained in:
Jonathan Marshall 2022-03-10 08:06:45 +00:00
parent 59e2ae5698
commit 22395217dd
1 changed files with 13 additions and 417 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

430
README.md
View File

@ -1,425 +1,21 @@
<h1 align="center"> WhiteSur GTK Theme </h1> # WhiteSur GTK Theme
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/macbook.png"/> </p> This repo is a fork of [vinceliuice/WhiteSur-gtk-theme](https://github.com/vinceliuice/WhiteSur-gtk-theme)
<br> ### Why?
<p align="center"> <b> A macOS BigSur-like theme for your GTK apps </b> </p> This fork is so that I can make a couple of very minor tweaks to the theme to suit my preferences.
<br> Changes:
* The app icon in the Gnome top bar is now full colour.
* The Nord theme will use the standard window titlebar min,max,close buttons.
* The Nord theme will mostly use the standard theme's colour pallete.
* nord-default is the standard blue.
* nord-blue is unchanged.
* All other nord colours are the same as their standard colour.
## My custom notes ## Installation
Install with: Install with:
``` ```
./install.sh --nordcolor -c dark ./install.sh --nordcolor -c dark
./tweaks.sh --flatpak --snap ./tweaks.sh --flatpak --snap
``` ```
For more information and options, see the parent repo [README](https://github.com/vinceliuice/WhiteSur-gtk-theme#readme)
# Installation is easy!
<details> <summary> Required dependencies info for nerds </summary>
### "Install from source" deps
- sassc
- libglib2.0-dev-bin `ubuntu 20.04`
- libglib2.0-dev `ubuntu 18.04` `debian 10.03` `linux mint 19`
- libxml2-utils `ubuntu 18.04` `debian 10.03` `linux mint 19`
- glib2-devel `Fedora` `Redhat`
### Misc deps
- imagemagick `(optional for GDM theme tweak)`
- dialog `(optional for installation in dialog mode)`
- optipng `(optional for asset rendering)`
- inkscape `(optional for asset rendering)`
Don't worry, WhiteSur installer already provides all of those dependencies.
</details>
<details> <summary> Recommended GNOME Shell extensions </summary>
- [user-themes](https://extensions.gnome.org/extension/19/user-themes/) to enable gnome-shell theme (and not just the application theme)
- [dash-to-dock](https://extensions.gnome.org/extension/307/dash-to-dock) `gnome-shell <= 3.38`
- [dash-to-dock](https://github.com/ewlsh/dash-to-dock/tree/ewlsh/gnome-40)
(GNOME Shell 40 patch) `gnome-shell >= 40.0`
- [floating-dock](https://extensions.gnome.org/extension/3730/floating-dock)
(Dash to Dock alternative) `gnome-shell <= 3.38`
- [blur-my-shell](https://extensions.gnome.org/extension/3193/blur-my-shell)
</details>
## Quick install
### Installing from source
Run `./install.sh` to install the default WhiteSur GTK theme pack which includes
GNOME Shell (Pantheon), Cinnamon, XFWM (XFCE), Metacity, and Plank themes.
## Quick uninstall
- uninstall Gtk themes: `./install.sh -r`
- uninstall GDM theme: `sudo ./tweaks.sh -g -r`
- uninstall Firefox theme: `./tweaks.sh -f -r`
- uninstall Dash-to-dock theme: `./tweaks.sh -d -r`
- uninstall Flatpak Gtk themes: `./tweaks.sh -F -r`
- uninstall Snap Gtk themes: `./tweaks.sh -s -r`
## There's so many customizations you can do!
Usage: `./install.sh [OPTIONS...]`
<details> <summary> Options </summary>
```bash
-d, --dest DIR
Set destination directory. Default is '/home/vince/.themes'
-n, --name NAME
Set theme name. Default is 'WhiteSur'
-o, --opacity [normal|solid]
Set theme opacity variants. Repeatable. Default is all variants
-c, --color [light|dark]
Set theme color variants. Repeatable. Default is all variants
-a, --alt [normal|alt|all]
Set window control buttons variant. Repeatable. Default is 'normal'
-t, --theme [default|blue|purple|pink|red|orange|yellow|green|grey|all]
Set theme accent color. Repeatable. Default is BigSur-like theme
-p, --panel-opacity [default|30|45|60|75]
Set panel transparency. Default is 15%
-P, --panel-size [default|smaller|bigger]
Set Gnome shell panel height size. Default is 32px
-s, --size [default|180|220|240|260|280]
Set Nautilus sidebar minimum width. Default is 200px
-i, --icon [standard|simple|gnome|ubuntu|tux|arch|manjaro|fedora|debian|void|opensuse|popos|mxlinux|zorin]
Set 'Activities' icon. Default is 'standard'
-b, --background [default|blank|IMAGE_PATH]
Set gnome-shell background image. Default is BigSur-like wallpaper
-m, --monterey
Set to MacOS Monterey style.
-N, --nautilus-style [stable|normal|mojave|glassy]
Set Nautilus style. Default is BigSur-like style (stabled sidebar)
-HD, --highdefinition
Set to High Definition size. Default is laptop size
--normal, --normalshowapps
Set gnome-shell show apps button style to normal. Default is bigsur
--round, --roundedmaxwindow
Set maximized window to rounded. Default is square
--right, --rightplacement
Set Nautilus titlebutton placement to right. Default is left
--black, --blackfont
Set panel font color to black. Default is white
--darker, --darkercolor
Install darker 'WhiteSur' dark themes.
--dialog, --interactive
Run this installer interactively, with dialogs.
--silent-mode
Meant for developers: ignore any confirm prompt and params become more strict.
-r, --remove, -u, --uninstall
Remove all installed WhiteSur themes.
-h, --help
Show this help.
```
</details>
### <p align="center"> <b> Change theme color and accent </b> </p>
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/colors-themes.png"/> </p>
#### Install theme color
Parameter: `--color` `-c` (repeatable)
Example:
```bash
./install.sh -c light # install light theme color only
./install.sh -c dark -c light # install dark and light theme colors
```
#### Install theme accent
Parameter: `--theme` `-t` (repeatable)
Example:
```bash
./install.sh -t red # install red theme accent only
./install.sh -t red -t green # install red and green theme accents
./install.sh -t all # install all available theme accents
```
### <p align="center"> <b> Change Nautilus sidebar minimum width </b> </p>
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/sidebars.png"/> </p>
Parameter: `--sidebar` `-s`
Example: `./install.sh -s 220`
### <p align="center"> <b> Change GNOME Shell 'Activities' icon </b> </p>
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/icons.png"/> </p>
Parameter: `--icon` `-i`
Example: `./install.sh -i fedora`
Note that you will need to enable the GNOME user-themes extension to change the shell theme (not to confuse with the application theme).
### <p align="center"> <b> Change Nautilus style </b> </p>
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/nautilus.png"/> </p>
Parameter: `--nautilus-style` `-N`
Example: `./install.sh -N mojave`
### <p align="center"> <b> Explore more customization features! </b> </p>
You can run `./install.sh -h` to explore more customization features we have
like changing panel opacity, theme opacity (normal and solid variant), window
control button variant, etc.
# Let's tweak!
Usage: `./tweaks.sh [OPTIONS...]`
<details> <summary> Options </summary>
```bash
-d, --dest DIR
Set destination directory. Default is '/home/vince/.themes'
-n, --name NAME
Set theme name. Default is 'WhiteSur'
-o, --opacity [normal|solid]
Set theme opacity variants. Repeatable. Default is all variants
-c, --color [light|dark]
Set theme color variants. Repeatable. Default is all variants
-a, --alt [normal|alt|all]
Set window control buttons variant. Repeatable. Default is 'normal'
-t, --theme [default|blue|purple|pink|red|orange|yellow|green|grey|all]
Set theme accent color. Repeatable. Default is BigSur-like theme
-p, --panel-opacity [default|30|45|60|75]
Set panel transparency. Default is 15%
-P, --panel-size [default|smaller|bigger]
Set Gnome shell panel height size. Default is 32px
-s, --size [default|180|220|240|260|280]
Set Nautilus sidebar minimum width. Default is 200px
-i, --icon [standard|simple|gnome|ubuntu|tux|arch|manjaro|fedora|debian|void|opensuse|popos|mxlinux|zorin]
Set 'Activities' icon. Default is 'standard'
-b, --background [default|blank|IMAGE_PATH]
Set gnome-shell background image. Default is BigSur-like wallpaper
-m, --monterey
Set to MacOS Monterey style.
-N, --nautilus-style [stable|normal|mojave|glassy]
Set Nautilus style. Default is BigSur-like style (stabled sidebar)
-HD, --highdefinition
Set to High Definition size. Default is laptop size
--normal, --normalshowapps
Set gnome-shell show apps button style to normal. Default is bigsur
--round, --roundedmaxwindow
Set maximized window to rounded. Default is square
--right, --rightplacement
Set Nautilus titlebutton placement to right. Default is left
--black, --blackfont
Set panel font color to black. Default is white
--darker, --darkercolor
Install darker 'WhiteSur' dark themes.
--nord, --nordcolor
Install 'WhiteSur' Nord ColorScheme themes.
--dialog, --interactive
Run this installer interactively, with dialogs.
--silent-mode
Meant for developers: ignore any confirm prompt and params become more strict.
-r, --remove, -u, --uninstall
Remove all installed WhiteSur themes.
-h, --help
Show this help.
```
</details>
## There's more themes you can try!
### <p align="center"> <b> Install and edit Firefox theme </b> </p>
<p align="center"> <a href="src/other/firefox">
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/firefox-whitesur.png"/>
</a> </p>
#### [Install Firefox theme](src/other/firefox)
Parameter: `--firefox` `-f`
Example: `./tweaks.sh -f`
#### Edit Firefox theme
Parameter: `--edit-firefox` `-e`
Example:
```bash
./tweaks.sh -f -e # install and edit Firefox theme
./tweaks.sh -e -f # it's reversible!
./tweaks.sh -e # edit the installed Firefox theme
./tweaks.sh -f -r # remove installed Firefox theme
```
#### Use Monterey style
<p align="center"> <a href="src/other/firefox">
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/firefox-monterey.png"/>
</a> </p>
Run:
```bash
./tweaks.sh -f monterey # install Monterey Firefox theme
```
### <p align="center"> <b> Install and customize Dash to Dock theme </b> </p>
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/dash-to-dock.png"/> </p>
#### Install Dash to Dock theme
Parameter: `--dash-to-dock` `-d`
Example: `./tweaks.sh -d`
#### Change its color
Parameter: `--color` `-c`
Example: `./tweaks.sh -d -c dark`
### <p align="center"> <b> Install and customize GDM theme </b> </p>
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/gdm.png"/> </p>
#### Install GDM theme
Parameter: `--gdm` `-g` (requires to be run as root)
Example: `sudo ./tweaks.sh -g`
#### Change the background
Parameter: `--background` `-b`
Example:
```bash
sudo ./tweaks.sh -g -b "my picture.jpg" # use the custom background
sudo ./tweaks.sh -g -b default # use the default background
sudo ./tweaks.sh -g -b blank # make it blank
```
#### Don't darken the background
Parameter: `--no-darken` `-N`
Example:
```bash
sudo ./tweaks.sh -g -N # darken the default background
sudo ./tweaks.sh -g -N -b "wallpapers/snow.jpg" # darken the custom background
```
#### Don't blur the background
Parameter: `--no-blur` `-n`
Example:
```bash
sudo ./tweaks.sh -g -n # don't blur the default background
sudo ./tweaks.sh -g -n -b "wallpapers/rocks.jpg" # don't blur the custom background
```
#### Do more GDM customizations
You can do [the similar customization features in `./install.sh`](#theres-so-many-customizations-you-can-do)
like changing theme color (dark and light variant) and accent, GNOME Shell
'Activities' icon, etc. related to GDM. Run `./tweaks.sh -h` to explore!
## Using WhiteSur theme on app sandboxing platforms
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/sandboxes.png"/> </p>
### <p align="center"> <b> Connect WhiteSur theme to Flatpak </b> </p>
Parameter: `--flatpak` `-F`
Example: `./tweaks.sh -F`
### <p align="center"> <b> Connect WhiteSur theme to your Snap apps </b> </p>
Parameter: `--snap` `-s`
Example: `./tweaks.sh -s`
Note:
> This can only connect WhiteSur theme to your currently installed Snap
> apps. You may need to run this command again to connect to your newly installed
> Snap apps
# Other recommended stuffs
## WhiteSur KDE Theme
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-kde">
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/whitesur-kde-theme.png"/>
</a> </p>
<br>
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-kde">
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/download-button.svg"/>
</a> </p>
<br>
## WhiteSur Icon Theme
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-icon-theme">
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/whitesur-icon-theme.png"/>
</a> </p>
<br>
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-icon-theme">
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/download-button.svg"/>
</a> </p>
<br>
## WhiteSur Wallpapers
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-wallpapers">
<img class="image" src="https://github.com/vinceliuice/WhiteSur-wallpapers/blob/main/1080p/WhiteSur-light.png"/>
</a> </p>
<br>
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-wallpapers">
<img class="image" src="https://github.com/vinceliuice/WhiteSur-wallpapers/blob/main/1080p/Monterey-light.png"/>
</a> </p>
<br>
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-wallpapers">
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/download-button.svg"/>
</a> </p>
<br>
# Technical details and getting involved
Please go read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more info