mirror of
https://github.com/jimeh/tmux-themepack.git
synced 2026-02-19 11:16:43 +00:00
docs: Update readme with new previews for version 1.0.0
This commit is contained in:
153
README.md
153
README.md
@@ -7,33 +7,35 @@ A pack of various themes for Tmux.
|
||||
|
||||
### Install manually
|
||||
|
||||
1. Clone repo to local machine:
|
||||
1. Clone repo to local machine:
|
||||
|
||||
git clone https://github.com/jimeh/tmux-themepack.git ~/.tmux-themepack
|
||||
|
||||
2. Source desired theme in your `~/.tmux.conf`:
|
||||
2. Source desired theme in your `~/.tmux.conf`:
|
||||
|
||||
source-file "${HOME}/.tmux-themepack/powerline/block/green.tmuxtheme"
|
||||
|
||||
In some linux distributions you might have to remove the quotation marks from the
|
||||
`source-file` command to avoid a `no such file or directory` error:
|
||||
|
||||
source-file ${HOME}/.tmux-themepack/powerline/block/green.tmuxtheme
|
||||
source-file "${HOME}/.tmux-themepack/powerline/default/green.tmuxtheme"
|
||||
|
||||
In some linux distributions you might have to remove the quotation marks
|
||||
from the `source-file` command to avoid a `no such file or directory` error:
|
||||
|
||||
source-file ${HOME}/.tmux-themepack/powerline/default/green.tmuxtheme
|
||||
|
||||
### Install using [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm)
|
||||
|
||||
1. Add plugin to the list of TPM plugins in `.tmux.conf`:
|
||||
1. Add plugin to the list of TPM plugins in `.tmux.conf`:
|
||||
|
||||
set -g @plugin 'jimeh/tmux-themepack'
|
||||
|
||||
2. Hit `prefix + I` to fetch the plugin and source it. The plugin should now be working.
|
||||
2. Press `prefix + I` to fetch the plugin and source it. The plugin should now
|
||||
be working.
|
||||
|
||||
You can pick and choose a theme via `.tmux.conf` option:
|
||||
Choose which theme is loaded by setting the `@themepack` option in your
|
||||
`.tmux.conf`:
|
||||
|
||||
- `set -g @themepack 'basic'` (default)
|
||||
- `set -g @themepack 'powerline/block/blue'`
|
||||
- `set -g @themepack 'powerline/block/cyan'`
|
||||
- `set -g @themepack 'powerline/default/gray'`
|
||||
- `set -g @themepack 'powerline/default/green'`
|
||||
- `set -g @themepack 'powerline/double/magenta'`
|
||||
- `...`
|
||||
|
||||
@@ -41,19 +43,18 @@ You can pick and choose a theme via `.tmux.conf` option:
|
||||
|
||||
### Basic Themes
|
||||
|
||||
**Default:**
|
||||
**Default (`default`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Basic:**
|
||||
**Basic (`basic`):**
|
||||
|
||||
|
||||
|
||||
|
||||
### Powerline Themes
|
||||
|
||||
Inspired by the [Powerline][] VIM plugin,
|
||||
and requires the use of a powerline compatible font in your terminal. You can
|
||||
find a number of such fonts in the
|
||||
Inspired by the [Powerline][] VIM plugin, and requires the use of a powerline
|
||||
compatible font in your terminal. You can find a number of such fonts in the
|
||||
[powerline-fonts][] project.
|
||||
|
||||
If your preferred font isn't available there, please refer to Powerline's
|
||||
@@ -63,106 +64,118 @@ documentation on [Font Patching][] to patch the font yourself.
|
||||
[powerline-fonts]: https://github.com/Lokaltog/powerline-fonts
|
||||
[font patching]: https://powerline.readthedocs.org/en/latest/fontpatching.html#font-patching
|
||||
|
||||
**Powerline Blue:**
|
||||
**Powerline Blue (`powerline/default/blue`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Cyan:**
|
||||
**Powerline Cyan (`powerline/default/cyan`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Gray:**
|
||||
**Powerline Gray (`powerline/default/gray`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Green:**
|
||||
**Powerline Green (`powerline/default/green`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Magenta:**
|
||||
**Powerline Magenta (`powerline/default/magenta`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Orange:**
|
||||
**Powerline Orange (`powerline/default/orange`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Red:**
|
||||
**Powerline Purple (`powerline/default/purple`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Yellow:**
|
||||
**Powerline Red (`powerline/default/red`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Yellow (`powerline/default/yellow`):**
|
||||
|
||||
|
||||
|
||||
#### Block
|
||||
|
||||
Currently selected window is indicated by a colored block.
|
||||
|
||||
**Powerline Blue Block:**
|
||||
**Powerline Blue Block (`powerline/block/blue`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Cyan Block:**
|
||||
**Powerline Cyan Block (`powerline/block/cyan`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Gray Block:**
|
||||
**Powerline Gray Block (`powerline/block/gray`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Green Block:**
|
||||
**Powerline Green Block (`powerline/block/green`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Magenta Block:**
|
||||
**Powerline Magenta Block (`powerline/block/magenta`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Orange Block:**
|
||||
**Powerline Orange Block (`powerline/block/orange`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Red Block:**
|
||||
**Powerline Purple Block (`powerline/block/purple`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Yellow Block:**
|
||||
**Powerline Red Block (`powerline/block/red`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Yellow Block (`powerline/block/yellow`):**
|
||||
|
||||
|
||||
|
||||
#### Double
|
||||
|
||||
Both left and right far sides of the statusbar are colored, rather than just
|
||||
the left side.
|
||||
Both left and right far sides of the statusbar are colored, rather than just the
|
||||
left side.
|
||||
|
||||
**Powerline Double Blue:**
|
||||
**Powerline Double Blue (`powerline/double/blue`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Double Cyan:**
|
||||
**Powerline Double Cyan (`powerline/double/cyan`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Double Green:**
|
||||
**Powerline Double Green (`powerline/double/green`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Double Magenta:**
|
||||
**Powerline Double Magenta (`powerline/double/magenta`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Double Orange:**
|
||||
**Powerline Double Orange (`powerline/double/orange`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Double Red:**
|
||||
**Powerline Double Purple (`powerline/double/purple`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Double Yellow:**
|
||||
**Powerline Double Red (`powerline/double/red`):**
|
||||
|
||||
|
||||
|
||||
|
||||
**Powerline Double Yellow (`powerline/double/yellow`):**
|
||||
|
||||
|
||||
|
||||
|
||||
## Tips
|
||||
@@ -177,9 +190,9 @@ If you decide to contribute your own tmux themes, please try to base it on the
|
||||
`default.tmuxtheme` theme. This ensures that switching between themes works as
|
||||
it should and completely overwrites all settings from previous themes.
|
||||
|
||||
If it's not possible to base your theme on my default one, something is
|
||||
probably missing from it. So please contribute a fix to the default theme too
|
||||
in that case :)
|
||||
If it's not possible to base your theme on my default one, something is probably
|
||||
missing from it. So please contribute a fix to the default theme too in that
|
||||
case :)
|
||||
|
||||
|
||||
## License
|
||||
|
||||
Reference in New Issue
Block a user