Skip to content

Commit

Permalink
docs: add clarifying note in the README about null values (#300)
Browse files Browse the repository at this point in the history
* readme: Add clarifying note about null values

* readme: Remove duplicate documentation of null values
  • Loading branch information
ItzYeho committed Sep 13, 2024
1 parent 8276c5a commit c43c10f
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,15 @@ This is a diagram of how the theme is split between its components.
## Configuration options

All flavors support certain levels of customization that match our [Catppuccin
Style Guide][style-guide]. To add these customizations, add any of the following
options to your Tmux configuration.
Style Guide][style-guide]. To add these customizations, you may add any of the
following options to your Tmux configuration.

If you want to set a text-based customization to an emtpy string, use `null` to
do so. For instance:

```sh
set -g @catppuccin_icon_window_last "null"
```

### Window

Expand Down Expand Up @@ -340,16 +347,6 @@ set -g @catppuccin_[module_name]_color "color"
set -g @catppuccin_[module_name]_text "text"
```

#### Removing a specific module option
```sh
set -g @catppuccin_[module_name]_[option] "null"
```
This is for the situation where you want to remove the icon from a module.
Ex:
```sh
set -g @catppuccin_date_time_icon "null"
```

### Battery module

#### Requirements
Expand Down

0 comments on commit c43c10f

Please sign in to comment.