ringofstorms/tmux-catppuccin-coal
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(README.md): fix minor spelling errors (#151)

Browse source
This commit is contained in:
Carlos Ortiz 2024-03-06 14:36:40 -06:00 • committed by GitHub
parent a0119d2528
commit 36a5b0584c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -46,7 +46,7 @@
## Installation ## Installation
In order to have the icons displayed correctly please use/update your favorite [patched font](https://www.nerdfonts.com/font-downloads). In order to have the icons displayed correctly please use/update your favorite [patched font](https://www.nerdfonts.com/font-downloads).
If you do not have a patched font installed, you can override or remove any icon. Check the documentation bellow on the options available. If you do not have a patched font installed, you can override or remove any icon. Check the documentation below on the options available.
### TPM ### TPM
@ -59,7 +59,7 @@ set -g @plugin 'catppuccin/tmux'
set -g @plugin 'tmux-plugins/tpm' set -g @plugin 'tmux-plugins/tpm'
``` ```
3. (Optional) Set your preferred flavour, it defaults to `"mocha"`: 3. (Optional) Set your preferred flavor, it defaults to `"mocha"`:
```bash ```bash
set -g @catppuccin_flavour 'latte' # or frappe, macchiato, mocha set -g @catppuccin_flavour 'latte' # or frappe, macchiato, mocha
@ -73,11 +73,11 @@ set -g @catppuccin_flavour 'latte' # or frappe, macchiato, mocha
## Overview ## Overview
![Default](./assets/overview.png) ![Default](./assets/overview.png)
This is a diagram on how the theme is split between it's components. This is a diagram of how the theme is split between its components.
## Configuration options ## Configuration options
All flavours support certain levels of customization that match our [Catppuccin All flavors support certain levels of customization that match our [Catppuccin
Style Guide][style-guide]. To add these customizations, add any of the following Style Guide][style-guide]. To add these customizations, add any of the following
options to your Tmux configuration. options to your Tmux configuration.
@ -187,13 +187,13 @@ set -g @catppuccin_window_current_text "#{b:pane_current_path}" # use "#W" for a
```sh ```sh
set -g @catppuccin_window_current_format_directory_text "#{b:pane_current_path}" set -g @catppuccin_window_current_format_directory_text "#{b:pane_current_path}"
``` ```
Use this to overide the way the current directory is displayed. Use this to override the way the current directory is displayed.
#### Set the directory format #### Set the directory format
```sh ```sh
set -g @catppuccin_window_format_directory_text "#{b:pane_current_path}" set -g @catppuccin_window_format_directory_text "#{b:pane_current_path}"
``` ```
Use this to overide the way the directory is displayed. Use this to override the way the directory is displayed.
### Pane ### Pane
@ -231,8 +231,8 @@ Values:
set -g @catppuccin_status_connect_separator "yes" set -g @catppuccin_status_connect_separator "yes"
``` ```
Values: Values:
- yes - the background color of the separator will not blend in with the brackground color of tmux - yes - the background color of the separator will not blend in with the background color of tmux
- no - the background color of the separator will blend in with the brackground color of tmux - no - the background color of the separator will blend in with the background color of tmux
#### Set the status module color fill: #### Set the status module color fill:
@ -312,7 +312,7 @@ set -g @catppuccin_date_time_icon "null"
This module depends on [tmux-battery](https://github.com/tmux-plugins/tmux-battery/tree/master). This module depends on [tmux-battery](https://github.com/tmux-plugins/tmux-battery/tree/master).
#### Install #### Install
The prefered way to install tmux-battery is using [TPM](https://github.com/tmux-plugins/tpm). The preferred way to install tmux-battery is using [TPM](https://github.com/tmux-plugins/tpm).
#### Configure #### Configure
Load tmux-battery after you load catppuccin. Load tmux-battery after you load catppuccin.
@ -333,7 +333,7 @@ set -g @catppuccin_status_modules_right "... battery ..."
This module depends on [tmux-cpu](https://github.com/tmux-plugins/tmux-cpu/tree/master). This module depends on [tmux-cpu](https://github.com/tmux-plugins/tmux-cpu/tree/master).
#### Install #### Install
The prefered way to install tmux-cpu is using [TPM](https://github.com/tmux-plugins/tpm). The preferred way to install tmux-cpu is using [TPM](https://github.com/tmux-plugins/tpm).
#### Configure #### Configure
Load tmux-cpu after you load catppuccin. Load tmux-cpu after you load catppuccin.
@ -354,7 +354,7 @@ set -g @catppuccin_status_modules_right "... cpu ..."
This module depends on [tmux-weather](https://github.com/xamut/tmux-weather). This module depends on [tmux-weather](https://github.com/xamut/tmux-weather).
#### Install #### Install
The prefered way to install tmux-cpu is using [TPM](https://github.com/tmux-plugins/tpm). The preferred way to install tmux-weather is using [TPM](https://github.com/tmux-plugins/tpm).
#### Configure #### Configure
Load tmux-weather after you load catppuccin. Load tmux-weather after you load catppuccin.
@ -371,7 +371,7 @@ set -g @catppuccin_status_modules_right "... weather ..."
## Create a custom module ## Create a custom module
It is possible to add a new custom module or overrite any of the existing modules. It is possible to add a new custom module or overwrite any of the existing modules.
Look into custom/README.md for more details. Look into custom/README.md for more details.
@ -385,7 +385,7 @@ When switching between configurations run:
```sh ```sh
tmux kill-server tmux kill-server
``` ```
In order to kill the tmux server and clear all global variables. To kill the tmux server and clear all global variables.
### Config 1 ### Config 1