Skip to content
This repository has been archived by the owner on Jun 2, 2024. It is now read-only.

docs: improve and fix the readme #197

Merged
merged 12 commits into from May 20, 2024
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 49 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ 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:
In order to install the theme using Python, curl the Python script and the output should look like this:
This conversation was marked as resolved.
Show resolved Hide resolved

```
curl -LsS "https://raw.githubusercontent.com/catppuccin/gtk/main/install.py" -o install.py
python3 install.py <flavor> <accent>
[catppuccin-gtk] [INFO] - Installation info:
flavor: mocha
accent: blue
dest: /home/****/.local/share/themes
dest: /home/<user>/.local/share/themes
link: False

remote_url: https://github.com/catppuccin/gtk/releases/download/v1.0.0-alpha/catppuccin-mocha-blue-standard+default.zip
Expand All @@ -46,18 +46,30 @@ python3 install.py <flavor> <accent>
[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-<flavor>-<accent>-standard+default"
sudo flatpak override --env=GTK_THEME=$THEME_DIR
```

This conversation was marked as resolved.
Show resolved Hide resolved
### 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):
This conversation was marked as resolved.
Show resolved Hide resolved

```bash
yay -S catppuccin-gtk-theme-<flavor>
paru -S catppuccin-gtk-theme-<flavor>
```
```bash
yay -S catppuccin-gtk-theme-<flavor>
paru -S catppuccin-gtk-theme-<flavor>
```

### 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, ...}: {
This conversation was marked as resolved.
Show resolved Hide resolved
imports = [inputs.catppuccin.homeManagerModules.catppuccin];

Expand All @@ -73,36 +85,39 @@ python3 install.py <flavor> <accent>
};
}
```
> [!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
export 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
export 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
export FLAVOR="mocha"
export 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"
```
This conversation was marked as resolved.
Show resolved Hide resolved

## Building
Expand Down