Skip to content

Commit

Permalink
docs: remove migration docs from the readme (catppuccin#361)
Browse files Browse the repository at this point in the history
* docs: remove migration docs from the readme

* Update README.md

Co-authored-by: Hammy <58985301+sgoudham@users.noreply.github.com>

---------

Co-authored-by: Hammy <58985301+sgoudham@users.noreply.github.com>
  • Loading branch information
kjnsn and sgoudham authored Oct 5, 2024
1 parent ff1aeb5 commit fe0d245
Showing 1 changed file with 12 additions and 17 deletions.
29 changes: 12 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ git clone https://github.com/catppuccin/tmux.git ~/.config/tmux/plugins/catppucc
```

2. Add the following line to your `tmux.conf` file:
`run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux`
`run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux`
3. (Optional) Set your preferred flavor and/or add configuration options as
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`
Expand All @@ -79,11 +79,13 @@ git clone https://github.com/catppuccin/tmux.git ~/.config/tmux/plugins/catppucc
2. Add the Catppuccin plugin:

<!-- x-release-please-start-version -->

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

<!-- x-release-please-end -->

3. (Optional) Set your preferred flavor, it defaults to `"mocha"`:
Expand Down Expand Up @@ -118,16 +120,9 @@ set -gF window-status-format "#[bg=#{@ctp_surface_1},fg=#{@ctp_fg}] ##I ##T "
set -gF window-status-current-format "#[bg=#{@ctp_mauve},fg=#{@ctp_crust}] ##I ##T "
```

### Upgrading from v0.3.0

If you are upgrading from 0.3.0 to any later versions, please note the following changes:

1. The `status-left` and `status-right` options are no longer controlled by this plugin.
You can adjust these manually. See the section on status line modules for more details.
1. Any custom status line modules may no longer work correctly, and will need to be rewritten
to maintain compatibility with newer plugin versions.
### Upgrading from 0.3

The plugin can be pinned to v0.3.0 if desired: `set -g @plugin 'catppuccin/tmux#v0.3.0'`.
Breaking changes have been introduced since 0.3, to understand how to migrate your configuration, see pinned issue [#291](https://github.com/catppuccin/tmux/issues/291).

## Recommended Default Configuration

Expand Down Expand Up @@ -175,13 +170,13 @@ options to your Tmux configuration.

The plugin comes with three window styles built in, these can be customized by setting the `@catppuccin_window_status_style` option. The default is `basic`.

| Option | Effect | Preview |
| --- | --- | --- |
| `basic` | Simple styling with blocks. | ![window basic](./assets/window-basic.webp) |
| `rounded` | Each window is separated with rounded separators. | ![window rounded style](./assets/window-rounded.webp) |
| `slanted` | Each window is separated with slanted separators. | ![window slanted style](./assets/window-slanted.webp) |
| `custom` | Custom separators are used. This is required to override the separators! | |
| `none` | Styling of the window status is completely disabled. | ![window no styling](./assets/window-none.webp) |
| Option | Effect | Preview |
| --------- | ------------------------------------------------------------------------ | ----------------------------------------------------- |
| `basic` | Simple styling with blocks. | ![window basic](./assets/window-basic.webp) |
| `rounded` | Each window is separated with rounded separators. | ![window rounded style](./assets/window-rounded.webp) |
| `slanted` | Each window is separated with slanted separators. | ![window slanted style](./assets/window-slanted.webp) |
| `custom` | Custom separators are used. This is required to override the separators! | |
| `none` | Styling of the window status is completely disabled. | ![window no styling](./assets/window-none.webp) |

If you want to change the active color to something else (the default is peach), use the following. For example to use lavender:

Expand Down

0 comments on commit fe0d245

Please sign in to comment.