technofab/tmux2k
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/tmux2k.git synced 2025-12-11 23:50:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update instructions

Browse source
This commit is contained in:
Abhishek Keshri 2024-03-17 04:39:32 +05:30
parent d2e517d76a
commit c4966c82a7
No known key found for this signature in database
1 changed files with 29 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -40,10 +40,6 @@
tmux2k is a `tmux` plugin for that adds `powerline` support and pretty colors to your `tmux` status bar.
## Inspiration
tmux2k was inspired by [dracula/tmux](https://github.com/dracula/tmux).
## Prerequisites
Before you begin, ensure you have met the following requirements:
@ -75,22 +71,24 @@ Add any configuration options below this line in your tmux config.
```bash
# Tmux 2K default configs
# available plugins: battery, cpu-usage, git, gpu-usage, ram-usage, network, network-bandwidth, network-ping, weather, time
set -g @tmux2k-left-plugins "git cpu-usage ram-usage"
# available plugins: battery, cpu, git, gpu, ram, network, bandwidth, ping, weather, time
set -g @tmux2k-left-plugins "git cpu ram"
set -g @tmux2k-right-plugins "battery network time"
set -g @tmux2k-show-powerline true
set -g @tmux2k-show-fahrenheit false
set -g @tmux2k-military-time true
set -g @tmux2k-border-contrast true
# available colors: white, gray, dark_gray, light_purple, dark_purple, cyan, green, orange, red, pink, yellow
# available colors: black, blue, cyan, gray, green, orange, pink, purple, red, white, yellow, light_cyan, light_gray, light_green, light_purple, light_red, light_yellow, plugin_fg
white, gray, dark_gray, light_purple, dark_purple, cyan, green, orange, red, pink, yellow
set -g @tmux2k-[plugin-name]-colors "[background] [foreground]"
set -g @tmux2k-cpu-usage-colors "blue dark_gray"
# it can accept `session`, `rocket`, `window`, or any character.
set -g @tmux2k-show-left-icon ""
set -g @tmux2k-show-left-icon ""
# network interface to monitor
# network interface to watch
set -g @tmux2k-network-name "en0"/"wlo1" (Mac/Linux)
# update powerline symbols
@ -99,6 +97,9 @@ set -g @tmux2k-show-right-sep ""
# change refresh rate
set -g @tmux2k-refresh-rate 5
# disable powerline
set -g @tmux2k-show-powerline false
```
## How it was built
@ -110,12 +111,15 @@ tmux2k was built using `neovim`, `shellcheck`, `nerd-fonts`.
- Learned a lot about the `tmux` and `tpm` ecosystem.
- Did some fancy shell scripting.
## Inspiration
tmux2k was inspired by [dracula/tmux](https://github.com/dracula/tmux).
## What's next
### To-Do
- [ ] Fix left plugins color logic
- [ ] Add more section scripts
You tell me!
### 🧰 Tooling