From 7fc71ae7878a48a23b27b1a495644294493ad7e4 Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Sun, 22 Dec 2019 10:06:07 +0000 Subject: [PATCH] docs: Update readme with new previews for version 1.0.0 --- README.md | 153 +++++++++++++++++++++++++++++------------------------- 1 file changed, 83 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index fc25902..aed759c 100644 --- a/README.md +++ b/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](https://raw.github.com/jimeh/tmux-themepack-previews/master/default-preview.png) +![basic](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/default-preview.png) -**Basic:** +**Basic (`basic`):** -![basic](https://raw.github.com/jimeh/tmux-themepack-previews/master/basic-preview.png) +![basic](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/basic-preview.png) ### 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-default-blue](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/default/blue-preview.png) +![powerline-default-blue](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/default/blue-preview.png) -**Powerline Cyan:** +**Powerline Cyan (`powerline/default/cyan`):** -![powerline-default-cyan](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/default/cyan-preview.png) +![powerline-default-cyan](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/default/cyan-preview.png) -**Powerline Gray:** +**Powerline Gray (`powerline/default/gray`):** -![powerline-default-gray](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/default/gray-preview.png) +![powerline-default-gray](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/default/gray-preview.png) -**Powerline Green:** +**Powerline Green (`powerline/default/green`):** -![powerline-default-green](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/default/green-preview.png) +![powerline-default-green](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/default/green-preview.png) -**Powerline Magenta:** +**Powerline Magenta (`powerline/default/magenta`):** -![powerline-default-magenta](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/default/magenta-preview.png) +![powerline-default-magenta](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/default/magenta-preview.png) -**Powerline Orange:** +**Powerline Orange (`powerline/default/orange`):** -![powerline-default-orange](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/default/orange-preview.png) +![powerline-default-orange](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/default/orange-preview.png) -**Powerline Red:** +**Powerline Purple (`powerline/default/purple`):** -![powerline-default-red](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/default/red-preview.png) +![powerline-default-purple](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/default/purple-preview.png) -**Powerline Yellow:** +**Powerline Red (`powerline/default/red`):** -![powerline-default-yellow](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/default/yellow-preview.png) +![powerline-default-red](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/default/red-preview.png) + +**Powerline Yellow (`powerline/default/yellow`):** + +![powerline-default-yellow](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/default/yellow-preview.png) #### Block Currently selected window is indicated by a colored block. -**Powerline Blue Block:** +**Powerline Blue Block (`powerline/block/blue`):** -![powerline-block-blue](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/block/blue-preview.png) +![powerline-block-blue](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/block/blue-preview.png) -**Powerline Cyan Block:** +**Powerline Cyan Block (`powerline/block/cyan`):** -![powerline-block-cyan](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/block/cyan-preview.png) +![powerline-block-cyan](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/block/cyan-preview.png) -**Powerline Gray Block:** +**Powerline Gray Block (`powerline/block/gray`):** -![powerline-block-gray](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/block/gray-preview.png) +![powerline-block-gray](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/block/gray-preview.png) -**Powerline Green Block:** +**Powerline Green Block (`powerline/block/green`):** -![powerline-block-green](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/block/green-preview.png) +![powerline-block-green](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/block/green-preview.png) -**Powerline Magenta Block:** +**Powerline Magenta Block (`powerline/block/magenta`):** -![powerline-block-magenta](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/block/magenta-preview.png) +![powerline-block-magenta](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/block/magenta-preview.png) -**Powerline Orange Block:** +**Powerline Orange Block (`powerline/block/orange`):** -![powerline-block-orange](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/block/orange-preview.png) +![powerline-block-orange](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/block/orange-preview.png) -**Powerline Red Block:** +**Powerline Purple Block (`powerline/block/purple`):** -![powerline-block-red](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/block/red-preview.png) +![powerline-block-purple](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/block/purple-preview.png) -**Powerline Yellow Block:** +**Powerline Red Block (`powerline/block/red`):** -![powerline-block-yellow](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/block/yellow-preview.png) +![powerline-block-red](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/block/red-preview.png) + +**Powerline Yellow Block (`powerline/block/yellow`):** + +![powerline-block-yellow](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/block/yellow-preview.png) #### 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-blue](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/double/blue-preview.png) +![powerline-double-blue](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/double/blue-preview.png) -**Powerline Double Cyan:** +**Powerline Double Cyan (`powerline/double/cyan`):** -![powerline-double-cyan](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/double/cyan-preview.png) +![powerline-double-cyan](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/double/cyan-preview.png) -**Powerline Double Green:** +**Powerline Double Green (`powerline/double/green`):** -![powerline-double-green](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/double/green-preview.png) +![powerline-double-green](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/double/green-preview.png) -**Powerline Double Magenta:** +**Powerline Double Magenta (`powerline/double/magenta`):** -![powerline-double-magenta](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/double/magenta-preview.png) +![powerline-double-magenta](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/double/magenta-preview.png) -**Powerline Double Orange:** +**Powerline Double Orange (`powerline/double/orange`):** -![powerline-double-orange](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/double/orange-preview.png) +![powerline-double-orange](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/double/orange-preview.png) -**Powerline Double Red:** +**Powerline Double Purple (`powerline/double/purple`):** -![powerline-double-red](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/double/red-preview.png) +![powerline-double-purple](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/double/purple-preview.png) -**Powerline Double Yellow:** +**Powerline Double Red (`powerline/double/red`):** -![powerline-double-yellow](https://raw.github.com/jimeh/tmux-themepack-previews/master/powerline/double/yellow-preview.png) +![powerline-double-red](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/double/red-preview.png) + +**Powerline Double Yellow (`powerline/double/yellow`):** + +![powerline-double-yellow](https://github.com/jimeh/tmux-themepack-previews/raw/1.0.0/powerline/double/yellow-preview.png) ## 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