Commit 0618deae authored by Pablo COVES's avatar Pablo COVES

README update

parent b318f217
......@@ -2,48 +2,30 @@
Yet, another tmux configuration.
## Install
## Usage
bash -c "$(curl -fsSL https://gitlab.com/pcoves/tmux/snippets/1687883/raw)"
### Install
No fancy stuff in this [script](https://gitlab.com/pcoves/tmux/snippets/1687883/raw).
git clone --recurse-submodules git@gitlab.com:pcoves/tmux.git
stow --ignore=\.git.\* -t ~ tmux
## Requirements
### Uninstall
* Git
stow -D -t ~ tmux
rm -rf tmux
### Add plugin
## Plugins
git submodule add $plugin
# Edit ~/.tmux.conf to execute plugin.tmux on start (RTFM).
git commit -m "Add $plugin"
git push
git submodule update --init --recursive -- $plugin
### Add
### Remove plugin
#### Clone plugin
cd ~/.tmux
git submodule add pluginAddress plugins/pluginName
#### Enable plugin
Edit `~/.tmux.conf` and add a `run-shell` line to that will run the plugin on tmux's startup.
### Remove
#### Disable plugin
Edit `~/.tmux.conf` and remove the corresponding `run-shell` instruction.
#### Deinit plugin
cd ~/.tmux
git submodule deinit -f pluginPath
rm -rf .git/modules/pluginPath
git rm -f pluginPath
## Tips
This boilerplate `bashrc` code will start a tmux session on terminal opening if needed or join an existing one otherwise.
if [[ -n "$DISPLAY" && $TMUX = "" ]]; then
tmux ls | grep -vq attached && TMUXARG="attach-session -d"
exec eval "tmux -2 $TMUXARG"
fi
git submodule deinit -f $plugin
rm -rf .git/modules/$plugin
git rm -f $plugin
git commit -m "Remove $plugin"
git push
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment