From 565cb2ef357ada1949beb44964b00fb8fc66e3d9 Mon Sep 17 00:00:00 2001 From: Omar <147266582+somerand0mcat@users.noreply.github.com> Date: Mon, 20 May 2024 10:44:22 +0300 Subject: [PATCH 01/10] improve readme --- README.md | 85 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 50 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 123ba45d..293fdb6c 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,11 @@ This GTK theme is based on the [Colloid](https://github.com/vinceliuice/Colloid- ## Installation This GTK theme requires: -- GTK >=3.20 +- GTK `>=3.20` - Python 3+ ### Automated script -We provide a Python script to automate the process of installing the theme: +We provide a Python script to automate the process of installing the theme, This is what the output will look like: ``` curl -LsS "https://raw.githubusercontent.com/catppuccin/gtk/main/install.py" -o install.py @@ -32,7 +32,7 @@ python3 install.py [catppuccin-gtk] [INFO] - Installation info: flavor: mocha accent: blue - dest: /home/****/.local/share/themes + dest: /home//.local/share/themes link: False remote_url: https://github.com/catppuccin/gtk/releases/download/v1.0.0-alpha/catppuccin-mocha-blue-standard+default.zip @@ -46,18 +46,30 @@ python3 install.py [catppuccin-gtk] [INFO] - Theme installation complete! ``` +### Flatpak +In order to give flatpaks access to the theme directory, run this command: +```bash +sudo flatpak override --filesystem=$HOME/.local/share/themes +``` + +Then, run this command to set the theme: +```bash +export THEME_DIR="~/.local/share/themes/catppuccin---standard+default" +sudo flatpak override --env=GTK_THEME=$THEME_DIR +``` + ### Arch Linux - With your favourite AUR helper, you can install your theme of choice: +With your favourite AUR helper, you can install the 4 flavors (Latte, Frappe, Macchiato, Mocha): - ```bash - yay -S catppuccin-gtk-theme- - paru -S catppuccin-gtk-theme- - ``` +```bash +yay -S catppuccin-gtk-theme- +paru -S catppuccin-gtk-theme- +``` ### Nix - We have created a Nix module ([catppuccin/nix](https://github.com/catppuccin/nix)) for theming apps under Nix, and recommend that you use it. - You can set up our Nix module for GTK with the following config: - ```nix +We have created a Nix module ([catppuccin/nix](https://github.com/catppuccin/nix)) for theming apps under Nix, and recommend that you use it. +You can set up our Nix module for GTK with the following config: +```nix {inputs, ...}: { imports = [inputs.catppuccin.homeManagerModules.catppuccin]; @@ -73,36 +85,39 @@ python3 install.py }; } ``` - > [!TIP] - > For further information on the options available with our module, see the [full documentation](https://github.com/catppuccin/nix/blob/main/docs/home-manager-options.md#gtkcatppuccinenable). +> [!TIP] +> For further information on the options available with our module, see the [full documentation](https://github.com/catppuccin/nix/blob/main/docs/home-manager-options.md#gtkcatppuccinenable). - Alternatively, if you are not using our Nix module, you can grab the theme from [nixpkgs/catppuccin-gtk](https://github.com/NixOS/nixpkgs/blob/master/pkgs/data/themes/catppuccin-gtk/default.nix) +Alternatively, if you are not using our Nix module, you can grab the theme from [nixpkgs/catppuccin-gtk](https://github.com/NixOS/nixpkgs/blob/master/pkgs/data/themes/catppuccin-gtk/default.nix) ### Manual installation - If your distro does not package our theme, and the installation script will not work for your use case, you can pull down releases and extract them yourself. You can find the [latest release on GitHub](https://github.com/catppuccin/gtk/releases/latest). +If your distro does not package our theme, and the installation script will not work for your use case, you can pull down releases and extract them yourself. You can find the [latest release on GitHub](https://github.com/catppuccin/gtk/releases/latest). - ```bash - cd ~/.local/share/themes +```bash +cd ~/.local/share/themes - local ROOT_URL="https://https://github.com/catppuccin/gtk/releases/download" +# Set the root URL +declare ROOT_URL="https://https://github.com/catppuccin/gtk/releases/download" - # Change to the tag you want to download - local RELEASE = "v1.0.0" +# Change to the tag you want to download +declare RELEASE = "v1.0.0" - # Change to suite your flavor / accent combination - local FLAVOR = "mocha" - local ACCENT = "mauve" - curl -LsS "${ROOT_URL}/${RELEASE}/catppuccin-${FLAVOR}-${ACCENT}-standard+default.zip" - - unzip catppuccin-${FLAVOR}-${ACCENT}-standard+default.zip - - export THEME_DIR="~/.local/share/themes/catppuccin-${FLAVOR}-${ACCENT}-standard+default" - - # Optionally, add support for libadwaita - mkdir -p "${HOME}/.config/gtk-4.0" && - ln -sf "${THEME_DIR}/gtk-4.0/assets" "${HOME}/.config/gtk-4.0/assets" && - ln -sf "${THEME_DIR}/gtk-4.0/gtk.css" "${HOME}/.config/gtk-4.0/gtk.css" && - ln -sf "${THEME_DIR}/gtk-4.0/gtk-dark.css" "${HOME}/.config/gtk-4.0/gtk-dark.css" +# Change to suite your flavor / accent combination +declare FLAVOR = "mocha" +declare ACCENT = "mauve" +curl -LsS "${ROOT_URL}/${RELEASE}/catppuccin-${FLAVOR}-${ACCENT}-standard+default.zip" + +# Extract the catppuccin zip file +unzip catppuccin-${FLAVOR}-${ACCENT}-standard+default.zip + +# Set the catppuccin theme directory +export THEME_DIR="~/.local/share/themes/catppuccin-${FLAVOR}-${ACCENT}-standard+default" + +# Optionally, add support for libadwaita +mkdir -p "${HOME}/.config/gtk-4.0" && +ln -sf "${THEME_DIR}/gtk-4.0/assets" "${HOME}/.config/gtk-4.0/assets" && +ln -sf "${THEME_DIR}/gtk-4.0/gtk.css" "${HOME}/.config/gtk-4.0/gtk.css" && +ln -sf "${THEME_DIR}/gtk-4.0/gtk-dark.css" "${HOME}/.config/gtk-4.0/gtk-dark.css" ``` ## Building @@ -114,7 +129,7 @@ If our prebuilt offerings do not match your requirements, you will have to build > [!WARNING] > We use a submodule to bring in colloid, the theme this theme is based on. You will need to clone -> with `git clone --recurse-submodules` to bring in the submodule. +> with `git clone --recurse-submodules` to bring in the submodule, or the theme will be broken. To build the theme, simply invoke `build.py`: ```bash From 5a6df0968c8aafbfc5942f43042f49ea034b709c Mon Sep 17 00:00:00 2001 From: Omar <147266582+somerand0mcat@users.noreply.github.com> Date: Mon, 20 May 2024 10:47:37 +0300 Subject: [PATCH 02/10] some fixes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 293fdb6c..61f22855 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ This GTK theme requires: - Python 3+ ### Automated script -We provide a Python script to automate the process of installing the theme, This is what the output will look like: +In order to install the theme using Python, curl the Python script and the output should look like this: ``` curl -LsS "https://raw.githubusercontent.com/catppuccin/gtk/main/install.py" -o install.py @@ -129,7 +129,7 @@ If our prebuilt offerings do not match your requirements, you will have to build > [!WARNING] > We use a submodule to bring in colloid, the theme this theme is based on. You will need to clone -> with `git clone --recurse-submodules` to bring in the submodule, or the theme will be broken. +> with `git clone --recurse-submodules` to bring in the submodule To build the theme, simply invoke `build.py`: ```bash From fd5e1fca82dce9bd07d937bb00d8164c2a2096ac Mon Sep 17 00:00:00 2001 From: Omar <147266582+somerand0mcat@users.noreply.github.com> Date: Mon, 20 May 2024 10:50:11 +0300 Subject: [PATCH 03/10] use export instead of declare --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 61f22855..477c99a4 100644 --- a/README.md +++ b/README.md @@ -97,14 +97,14 @@ If your distro does not package our theme, and the installation script will not cd ~/.local/share/themes # Set the root URL -declare ROOT_URL="https://https://github.com/catppuccin/gtk/releases/download" +export ROOT_URL="https://https://github.com/catppuccin/gtk/releases/download" # Change to the tag you want to download -declare RELEASE = "v1.0.0" +export RELEASE="v1.0.0" # Change to suite your flavor / accent combination -declare FLAVOR = "mocha" -declare ACCENT = "mauve" +export FLAVOR="mocha" +export ACCENT="mauve" curl -LsS "${ROOT_URL}/${RELEASE}/catppuccin-${FLAVOR}-${ACCENT}-standard+default.zip" # Extract the catppuccin zip file From 182e4f0ce7ab15c443ce971f61208d31fdfcb8c3 Mon Sep 17 00:00:00 2001 From: Omar <147266582+somerand0mcat@users.noreply.github.com> Date: Mon, 20 May 2024 10:52:11 +0300 Subject: [PATCH 04/10] add the dot --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 477c99a4..f386d552 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ If our prebuilt offerings do not match your requirements, you will have to build > [!WARNING] > We use a submodule to bring in colloid, the theme this theme is based on. You will need to clone -> with `git clone --recurse-submodules` to bring in the submodule +> with `git clone --recurse-submodules` to bring in the submodule. To build the theme, simply invoke `build.py`: ```bash From 5e19afb2d3bbbd994115fd8230de42b8158f7e28 Mon Sep 17 00:00:00 2001 From: Omar <147266582+somerand0mcat@users.noreply.github.com> Date: Mon, 20 May 2024 13:08:49 +0300 Subject: [PATCH 05/10] remove space --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index f386d552..a8601016 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,6 @@ You can set up our Nix module for GTK with the following config: ```nix {inputs, ...}: { imports = [inputs.catppuccin.homeManagerModules.catppuccin]; - gtk = { enable = true; catppuccin = { From 62b818d8815300267b569be344bcdef2985dd554 Mon Sep 17 00:00:00 2001 From: Omar <147266582+somerand0mcat@users.noreply.github.com> Date: Mon, 20 May 2024 13:14:28 +0300 Subject: [PATCH 06/10] remove indent --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a8601016..1c594d22 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ mkdir -p "${HOME}/.config/gtk-4.0" && ln -sf "${THEME_DIR}/gtk-4.0/assets" "${HOME}/.config/gtk-4.0/assets" && ln -sf "${THEME_DIR}/gtk-4.0/gtk.css" "${HOME}/.config/gtk-4.0/gtk.css" && ln -sf "${THEME_DIR}/gtk-4.0/gtk-dark.css" "${HOME}/.config/gtk-4.0/gtk-dark.css" - ``` +``` ## Building If our prebuilt offerings do not match your requirements, you will have to build the theme from source. From cb4df8f2eb5f4e4beacdf09cc0e5dac1447d2f4f Mon Sep 17 00:00:00 2001 From: Omar <147266582+somerand0mcat@users.noreply.github.com> Date: Mon, 20 May 2024 13:16:14 +0300 Subject: [PATCH 07/10] update readme --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 1c594d22..405a90f6 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,6 @@ This GTK theme is based on the [Colloid](https://github.com/vinceliuice/Colloid-gtk-theme) theme made by [vinceliuice](https://github.com/vinceliuice) - ## Installation This GTK theme requires: - GTK `>=3.20` @@ -70,7 +69,7 @@ paru -S catppuccin-gtk-theme- We have created a Nix module ([catppuccin/nix](https://github.com/catppuccin/nix)) for theming apps under Nix, and recommend that you use it. You can set up our Nix module for GTK with the following config: ```nix - {inputs, ...}: { + {inputs, ...}: { imports = [inputs.catppuccin.homeManagerModules.catppuccin]; gtk = { enable = true; From 90b65dc753a0752484a36076c16d39bda0eeee33 Mon Sep 17 00:00:00 2001 From: Willow <42willow@pm.me> Date: Mon, 20 May 2024 20:29:46 +1000 Subject: [PATCH 08/10] docs(README): fix indents and md lint --- README.md | 54 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 34 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 405a90f6..e79cffc4 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@

- Logo
- - Catppuccin for GTK - + Logo
+ + Catppuccin for GTK +

- - - + + +

@@ -18,14 +18,17 @@ This GTK theme is based on the [Colloid](https://github.com/vinceliuice/Colloid-gtk-theme) theme made by [vinceliuice](https://github.com/vinceliuice) ## Installation + This GTK theme requires: + - GTK `>=3.20` - Python 3+ ### Automated script + In order to install the theme using Python, curl the Python script and the output should look like this: -``` +```bash curl -LsS "https://raw.githubusercontent.com/catppuccin/gtk/main/install.py" -o install.py python3 install.py [catppuccin-gtk] [INFO] - Installation info: @@ -46,18 +49,22 @@ python3 install.py ``` ### Flatpak + In order to give flatpaks access to the theme directory, run this command: + ```bash sudo flatpak override --filesystem=$HOME/.local/share/themes ``` Then, run this command to set the theme: + ```bash export THEME_DIR="~/.local/share/themes/catppuccin---standard+default" sudo flatpak override --env=GTK_THEME=$THEME_DIR ``` ### Arch Linux + With your favourite AUR helper, you can install the 4 flavors (Latte, Frappe, Macchiato, Mocha): ```bash @@ -66,29 +73,33 @@ paru -S catppuccin-gtk-theme- ``` ### Nix + We have created a Nix module ([catppuccin/nix](https://github.com/catppuccin/nix)) for theming apps under Nix, and recommend that you use it. You can set up our Nix module for GTK with the following config: + ```nix - {inputs, ...}: { - imports = [inputs.catppuccin.homeManagerModules.catppuccin]; - gtk = { +{inputs, ...}: { + imports = [inputs.catppuccin.homeManagerModules.catppuccin]; + gtk = { + enable = true; + catppuccin = { enable = true; - catppuccin = { - enable = true; - flavor = "mocha"; - accent = "pink"; - size = "standard"; - tweaks = [ "normal" ]; - }; + flavor = "mocha"; + accent = "pink"; + size = "standard"; + tweaks = [ "normal" ]; }; - } - ``` + }; +} +``` + > [!TIP] > For further information on the options available with our module, see the [full documentation](https://github.com/catppuccin/nix/blob/main/docs/home-manager-options.md#gtkcatppuccinenable). Alternatively, if you are not using our Nix module, you can grab the theme from [nixpkgs/catppuccin-gtk](https://github.com/NixOS/nixpkgs/blob/master/pkgs/data/themes/catppuccin-gtk/default.nix) ### Manual installation + If your distro does not package our theme, and the installation script will not work for your use case, you can pull down releases and extract them yourself. You can find the [latest release on GitHub](https://github.com/catppuccin/gtk/releases/latest). ```bash @@ -119,9 +130,11 @@ ln -sf "${THEME_DIR}/gtk-4.0/gtk-dark.css" "${HOME}/.config/gtk-4.0/gtk-dark.css ``` ## Building + If our prebuilt offerings do not match your requirements, you will have to build the theme from source. ### Requirements + - Python 3+ - `sassc`, the Sass compiler @@ -130,6 +143,7 @@ If our prebuilt offerings do not match your requirements, you will have to build > with `git clone --recurse-submodules` to bring in the submodule. To build the theme, simply invoke `build.py`: + ```bash python3 build.py mocha --dest ./build -a rosewater --tweaks rimless [catppuccin-gtk] [INFO] - Patches seem to be applied, remove "colloid/.patched" to force application (this may fail) From d6a58670a796a31919d78eaef2e3184118121558 Mon Sep 17 00:00:00 2001 From: Omar <147266582+somerand0mcat@users.noreply.github.com> Date: Mon, 20 May 2024 13:45:28 +0300 Subject: [PATCH 09/10] remove another indent --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 405a90f6..7d5b2827 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ paru -S catppuccin-gtk-theme- We have created a Nix module ([catppuccin/nix](https://github.com/catppuccin/nix)) for theming apps under Nix, and recommend that you use it. You can set up our Nix module for GTK with the following config: ```nix - {inputs, ...}: { +{inputs, ...}: { imports = [inputs.catppuccin.homeManagerModules.catppuccin]; gtk = { enable = true; From 3dcfc95d43fde8686888c4aae8f371764da405a5 Mon Sep 17 00:00:00 2001 From: Omar <147266582+somerand0mcat@users.noreply.github.com> Date: Mon, 20 May 2024 14:01:11 +0300 Subject: [PATCH 10/10] fix some issues --- README.md | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index e79cffc4..3b50a6eb 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ This GTK theme requires: ### Automated script -In order to install the theme using Python, curl the Python script and the output should look like this: +We provide a Python script to automate the process of installing the theme: ```bash curl -LsS "https://raw.githubusercontent.com/catppuccin/gtk/main/install.py" -o install.py @@ -48,24 +48,9 @@ python3 install.py [catppuccin-gtk] [INFO] - Theme installation complete! ``` -### Flatpak - -In order to give flatpaks access to the theme directory, run this command: - -```bash -sudo flatpak override --filesystem=$HOME/.local/share/themes -``` - -Then, run this command to set the theme: - -```bash -export THEME_DIR="~/.local/share/themes/catppuccin---standard+default" -sudo flatpak override --env=GTK_THEME=$THEME_DIR -``` - ### Arch Linux -With your favourite AUR helper, you can install the 4 flavors (Latte, Frappe, Macchiato, Mocha): +With your favourite AUR helper, you can install your flavor of choice: ```bash yay -S catppuccin-gtk-theme-