From 22395217dd7300ee7d1f9ef7fda20ff34da9c2a6 Mon Sep 17 00:00:00 2001 From: Jonathan Marshall Date: Thu, 10 Mar 2022 08:06:45 +0000 Subject: [PATCH] Update readme. --- README.md | 430 ++---------------------------------------------------- 1 file changed, 13 insertions(+), 417 deletions(-) diff --git a/README.md b/README.md index 073e60e..b309814 100644 --- a/README.md +++ b/README.md @@ -1,425 +1,21 @@ -

WhiteSur GTK Theme

-

+# WhiteSur GTK Theme +This repo is a fork of [vinceliuice/WhiteSur-gtk-theme](https://github.com/vinceliuice/WhiteSur-gtk-theme) -
-

A macOS BigSur-like theme for your GTK apps

-
+### Why? +This fork is so that I can make a couple of very minor tweaks to the theme to suit my preferences. +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.sh --nordcolor -c dark ./tweaks.sh --flatpak --snap ``` - -# Installation is easy! -
Required dependencies info for nerds - -### "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. -
- -
Recommended GNOME Shell extensions - -- [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) - -
- -## 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...]` - -
Options - -```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. -``` - -
- -###

Change theme color and accent

-

- -#### 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 -``` - -###

Change Nautilus sidebar minimum width

-

- -Parameter: `--sidebar` `-s` - -Example: `./install.sh -s 220` - - -###

Change GNOME Shell 'Activities' icon

-

- -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). - - -###

Change Nautilus style

-

- -Parameter: `--nautilus-style` `-N` - -Example: `./install.sh -N mojave` - - -###

Explore more customization features!

-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...]` - -
Options - -```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. -``` - -
- -## There's more themes you can try! -###

Install and edit Firefox theme

- -

- -

- -#### [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 -

- -

- -Run: - -```bash -./tweaks.sh -f monterey # install Monterey Firefox theme -``` - -###

Install and customize Dash to Dock theme

-

- -#### 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` - -###

Install and customize GDM theme

-

- -#### 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 -

- -###

Connect WhiteSur theme to Flatpak

-Parameter: `--flatpak` `-F` - -Example: `./tweaks.sh -F` - -###

Connect WhiteSur theme to your Snap apps

-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 -

- -

-
-

- -

-
- -## WhiteSur Icon Theme -

- -

-
-

- -

-
- -## WhiteSur Wallpapers -

- -

-
-

- -

-
-

- -

-
- -# Technical details and getting involved -Please go read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more info +For more information and options, see the parent repo [README](https://github.com/vinceliuice/WhiteSur-gtk-theme#readme) \ No newline at end of file