Compare commits

..

2 commits

Author SHA1 Message Date
Maciej Sypien
f555bbcaf2
docs: update README 2024-11-15 08:19:21 +01:00
Maciej Sypien
60fd88f680
docs: improve theme documentation and migration guide v1 to v2 2024-09-29 23:40:55 +02:00
5 changed files with 41 additions and 39 deletions

View file

@ -9,20 +9,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Added
### Changed
### Deprecated
### Removed
### Fixed
### Security
## [v2.0.0]
### Added
- Added light and dark transparent themes [#18](https://github.com/egel/tmux-gruvbox/issues/18)
- Added editorconfig
- Added code linters for shellcheck & shfmt [#33](https://github.com/egel/tmux-gruvbox/issues/33)
@ -70,5 +56,3 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
[Unreleased]: https://github.com/egel/tmux-gruvbox/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/egel/tmux-gruvbox/compare/v0.0.0...v1.0.0
[1.1.0]: https://github.com/egel/tmux-gruvbox/compare/v1.0.0...v1.1.0
[2.0.0]: https://github.com/egel/tmux-gruvbox/compare/v1.1.0...v2.0.0

View file

@ -36,7 +36,7 @@ Add plugin at the top list of TPM plugins list in `.tmux.conf` and select desire
set -g @plugin 'tmux-plugins/tpm' # mandatory
set -g @plugin 'tmux-plugins/tmux-sensible' # optional recommended
set -g @plugin 'https://git.k4li.de/mirrors/tmux-gruvbox'
set -g @plugin 'egel/tmux-gruvbox'
# set desired theme options...
set -g @tmux-gruvbox 'dark' # or 'dark256', 'light', 'light256'
@ -47,7 +47,7 @@ set -g @tmux-gruvbox 'dark' # or 'dark256', 'light', 'light256'
Hit `prefix + I` to fetch the plugin and source it. Your Tmux should be updated with the theme at this point.
> [!NOTE]
> If you used v1 before and interested to adapt to v2 use this [Migration Guide from v1 to v2][docs-migration-guide-from-v1-to-v2].
> If you used v1 before and interested to adpt to v2 use this [Migration Guide from v1 to v2][docs-migration-guide-from-v1-to-v2].
### Install manually
@ -129,6 +129,10 @@ set -g @tmux-gruvbox-left-status-a '#S' # tmux's session name
This section is customizable for user, and by default contains current date.
> [!TIP]
> Some user may have problem with displaying dates in desired format, if this
> case for you try using double percent `%%`
```bash
# set date in US notation
set -g @tmux-gruvbox-right-status-x '%m/%d/%Y' # e.g.: 01/31/2024
@ -139,10 +143,6 @@ set -g @tmux-gruvbox-right-status-x '%m/%d/%Y' # e.g.: 01/31/2024
set -g @tmux-gruvbox-right-status-x '%d.%m.%Y' # e.g.: 30.01.2024
```
> [!TIP]
> Some user may have problem with displaying dates in desired format, if this
> case for you try using double percent `%%`
### Right Status (Section Y)
- default value: `'%H:%M'`

View file

@ -2,11 +2,15 @@
Hello there!
I am so happy to see you here and are interested in using the new version of tmux-gruvbox theme.
I am so happy to see you here and being interested in using new version of
tmux-gruvbox theme.
I really try to do all my best giving you new, interesting features that you probably always wanted to have.
I really try to do all my best giving you new, interesting features that you
probably always wanted to have.
In here I also wanted to thank you all people involved in contributing to this theme 🙏🙇. Especially for adding all suggestions, or reporting problems if they occurred - this helped a lot!
In here I also wanted to thank you all people involved in contributing to this
theme 🙏🙇. Especially for adding all suggestions, or reporting problems if
they occurred - this helped a lot!
## What's new?
@ -21,25 +25,35 @@ See what's new in [CHANGELOG][docs-changelog].
## Breaking changes
I planned to have best possible user experience between migrating from v1 and v2, therefore tried to build new changes this way to keep the breaking changes as low as possible. This was not ideal, although I believe for many this would not require many changes and for some none.
I planned to have best possible user experience between migrating from v1 and v2,
therefore tried to build new changes this way to keep the breaking changes
as low as possible. This was not ideal, although I believe for many this would not
require many changes and for some none.
### Theme names changes
### Theme names change
| v1 | v2 | description |
| :-----------------: | :--------: | ----------------------------------------------------------------------- |
| `dark` | `dark256` | 256-colors theme |
| `light` | `light256` | 256-colors theme |
| `dark` | `dark256` | |
| `light` | `light256` | |
| `dark-transparent` | ∅ | set `dark` or `dark256` theme and add `@tmux-gruvbox-statusbar-alpha` |
| `light-transparent` | ∅ | set `light` or `light256` theme and add `@tmux-gruvbox-statusbar-alpha` |
In v2 we've introduced a 16-bit color themes that should give the users more happiness utilizing a greater amount of supported colors (full gruvbox palette).
In v2 we've introduced a 16-bit color themes that should give the users more
happiness utilizing a greater amount of supported colors (full gruvbox palette).
Therefore in v2 themes `light` & `dark` has been simply renamed and `256` postfix has been added to indicate used palette. In v2 `light` & `dark` themes will be refering to 16-bit versions.
Therefore in v1 theme `light` & `dark` has been simply renamed and `256` postfix
has been added to indicate used palette.
> [!NOTE]
> While implementing 16-bit colors I realized that many users (including me) had problems with setting up correct the color interpretation in their workspace to support multiple colors.
> While implementing 16-bit colors I realized that many users (including me) had
> problems with setting up correct the color interpretation in their workspace
> to support multiple colors.
>
> Here is the page [True Color (24-bit) and italics with alacritty + tmux + vim (neovim)][github-gist-andersevenrud-alacritty-tmux-vim-truecolor] where I found great wisdom how to adjust my terminal, especially when used alacritty, tmux & neovim.
> Here is the page
> [True Color (24-bit) and italics with alacritty + tmux + vim (neovim)][github-gist-andersevenrud-alacritty-tmux-vim-truecolor]
> where I found great wisdom how to adjust my terminal, especially when used
> alacritty, tmux & neovim.
### Fallback theme name
@ -47,11 +61,15 @@ Therefore in v2 themes `light` & `dark` has been simply renamed and `256` postfi
| :----: | :-------: |
| `dark` | `dark256` |
Continuing topic of introducing 16-bit colors, we have make slight change in fallback theme name. We love idea adding new colors to our theme, although during those changes we cannot forget about users whose terminals might not support more then basic 256 colors. Therefore the fallback theme name also has to be adapted and in v2 it's `dark256`.
Continuing topic of introducing 16-bit colors, we have make slight change in
fallback theme name. We love idea adding new colors to our theme, although
during those changes we cannot forget about users whose terminals might not
support more then basic 256 colors. Therefore the fallback theme name also has
to be adapted and in v2 it's `dark256`.
## FAQ
### Plugin not upgrading automatically with tmux update
### Plugin not upgrading automaticaly with tmux update
Error ([source](https://github.com/egel/tmux-gruvbox/issues/21#issuecomment-2373794273)):

View file

@ -23,10 +23,10 @@ readonly TMUX_GRUVBOX_RIGHT_STAUTS_Z="@tmux-gruvbox-right-status-z"
readonly DEFAULT_THEME="dark256"
readonly DEFAULT_STATUSBAR_ALPHA='false'
# defaults for theme option (with color interpolation)
readonly DEFAULT_LEFT_STATUS_A=' 󰊠 '
readonly DEFAULT_RIGHT_STATUS_X='%d.%m.%Y'
readonly DEFAULT_LEFT_STATUS_A='#S'
readonly DEFAULT_RIGHT_STATUS_X='%Y-%m-%d'
readonly DEFAULT_RIGHT_STATUS_Y='%H:%M'
readonly DEFAULT_RIGHT_STATUS_Z="$USER@#h "
readonly DEFAULT_RIGHT_STATUS_Z='#h'
main() {
TMUX_CMDS=() # clear

View file

@ -25,7 +25,7 @@ col_gray2=colour245
col_bg0_s=colour236
col_fg=colour223
col_fg4=colour246
col_fg3=colour167
col_fg3=colour248
col_fg2=colour250
col_fg1=colour223
col_fg0=colour229