Skip to content

Commit

Permalink
docs: Issue catppuccin#345 - clarifying steps for status modules (cat…
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffcap1 authored Oct 9, 2024
1 parent 06fff2f commit da28bb2
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ git clone https://github.com/catppuccin/tmux.git ~/.config/tmux/plugins/catppucc
listed in [Configuration Options](#configuration-options). These options must be added above the `run ~/.config...` line.
4. Reload Tmux by either restarting or reloading with `tmux source ~/.tmux.conf`

> [!IMPORTANT]
> [!IMPORTANT]
> You may have to run `~/.config/tmux/plugins/tpm/bin/clean_plugins` if upgrading from an earlier version
> (especially from `v0.3.0`).
Expand Down Expand Up @@ -148,6 +148,7 @@ set -g @catppuccin_window_current_background "#{@thm_mauve}"

# Load catppuccin
run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux
# For TPM, instead use `run ~/.config/tmux/plugins/tmux/catppuccin.tmux`

# Make the status line pretty and add some modules
set -g status-left ""
Expand Down
25 changes: 24 additions & 1 deletion status/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

### Customizing modules

Every module (except the module "session") supports the following overrides:
Expand Down Expand Up @@ -34,6 +33,30 @@ Ex:
set -g @catppuccin_date_time_icon "null"
```

### Notes for TPM users

Make sure you load the catppuccin theme prior to setting the status-left and/or status-left options. This ensures the catppuccin options (such as colors and status modules) are defined so they can then be used.
<br><br>
After status-left and/or status-left have been set, make sure to run TPM to load the modules. This runs any plugins that may replace text in the status line.

```bash
# load catppuccin theme ...
run '~/.config/tmux/plugins/tmux/catppuccin.tmux' # or where this file is located on your machine

# ... and then set status-left & status-right ...
set -g status-left "#{E:@catppuccin_status_session}"

set -g status-right "#{E:@catppuccin_status_[module_name]}"
set -ag status-right "#{E:@catppuccin_status_[module_name]}"
set -agF status-right "#{E:@catppuccin_status_[module_name]}"

# ... and finally start TPM
run '~/.tmux/plugins/tpm/tpm'

set -g @plugin 'catppuccin/tmux#v1.0.1' # See https://github.com/catppuccin/tmux/tags for additional tags
set -g @plugin 'tmux-plugins/tpm'
```

### Battery module

#### Requirements
Expand Down

0 comments on commit da28bb2

Please sign in to comment.