feat: update readme

This commit is contained in:
Maciej Sypien 2024-09-14 19:54:20 +02:00 committed by Maciej Sypien
parent bf07efd322
commit 1b97d625e6

View file

@ -56,24 +56,32 @@ Hit `prefix + I` to fetch the plugin and source it. Your Tmux should be updated
## Development
To run project locally pull the repo to desired place
To run project locally:
1. clone the repo to desired place
```bash
cd $HOME/privatespace/
cd $HOME/projects/
git clone ...
```
and in `~/.tmux.conf` set
1. create symlink in plugin dir to the cloned repo:
```bash
# cd to tmux plugin directory
cd ~/.tmux/plugins/
# create simlink to
ln -sf $HOME/privatespace/tmux-gruvbox/ tmux-gruvbox
# create simlink to cloned repo
ln -sf $HOME/projects/tmux-gruvbox/ tmux-gruvbox
```
1. and in `~/.tmux.conf` set
```bash
# add plugin
set -g @plugin 'egel/tmux-gruvbox'
# set desired options...
set -g @tmux-gruvbox 'dark-transparent'
set -g @tmux-gruvbox 'dark'
```
### Linters & formatters