Update with icon customization

This commit is contained in:
VeejeyPL 2023-06-06 12:33:05 +02:00
parent 19a7878802
commit 5b0433d599
5 changed files with 66 additions and 24 deletions

View file

@ -31,6 +31,7 @@
3. [Enable date and time](#enable-datetime)
4. [Enable user](#enable-user)
5. [Enable host](#enable-host)
6. [Customize icons](#customize-icons)
## Themes
@ -41,7 +42,7 @@
## Installation
In order to have the icons displayed correctly please use / update your favorite patched font.
In order to have the icons displayed correctly please use / update your favorite patched font or overwrite the defaults - refer to [Customize icons](#customize-icons) section.
If you do not have patched font installed, you can use the [No patched fonts](#no-patched-fonts) status line theme.
### TPM
@ -147,8 +148,8 @@ set -g @catppuccin_r_left_separator "█"
### Enable DateTime
By default, the `date_time` componenet is set to off.
It can be enabled by specifing any tmux date and time format.
By default, the `date_time` component is set to off.
It can be enabled by specifying any tmux date and time format.
```sh
set -g @catppuccin_date_time "%Y-%m-%d %H:%M"
@ -156,7 +157,7 @@ set -g @catppuccin_date_time "%Y-%m-%d %H:%M"
### Enable User
By default, the `user` componenet is set to off.
By default, the `user` component is set to off.
It can be enabled by toggling it on.
```sh
@ -165,13 +166,29 @@ set -g @catppuccin_user "on"
### Enable Host
By default, the `host` componenet is set to off.
By default, the `host` component is set to off.
It can be enabled by toggling it on.
```sh
set -g @catppuccin_host "on"
```
### Customize Icons
Each of the components comes with their own default icon, which
can be changed to fit your preference or requirements of your font.
*Note: NerdFont Icons do not render properly in the Github UI, so the below example
does not use them*
```sh
set -g @catppuccin_datetime_icon "A"
set -g @catppuccin_user_icon "B"
set -g @catppuccin_directory_icon "C"
set -g @catppuccin_window_icon "D"
set -g @catppuccin_session_icon "E"
set -g @catppuccin_host_icon "F"
```
[style-guide]: https://github.com/catppuccin/catppuccin/blob/main/docs/style-guide.md
## 💝 Thanks to