update readme
This commit is contained in:
parent
d34e5aad31
commit
ce56c1aad1
40
README.md
40
README.md
|
@ -3,7 +3,7 @@
|
|||
![Tmux](https://img.shields.io/badge/tmux-v3.3-brightgreen)
|
||||
![Fzf](https://img.shields.io/badge/fzf-v0.35-green)
|
||||
|
||||
**tmuxrc** is a collection of [RUNCOM][RUNCOM] & plugins dedicated to the terminal multiplexer [Tmux][TMUX_repo].
|
||||
**tmuxrc** is a collection of [RUNCOM][RUNCOM] & Plugins dedicated to the terminal multiplexer [Tmux][TMUX_repo].
|
||||
|
||||
- I use this configuration with my custom [bash environment][bashrc_repo] to always work in Tmux locally and in SSH sessions.
|
||||
|
||||
|
@ -11,16 +11,16 @@
|
|||
|
||||
## Features
|
||||
|
||||
- Plugins:
|
||||
- [tpm][tpm]: Plugin Manager
|
||||
- [tmux-prefix-highlight][tmux-prefix-highlight]: highlights when you press tmux prefix key
|
||||
- [tmux-menus][tmux-menus]: Popup menus
|
||||
- [extrakto][extrakto]: quickly select, copy/insert/complete text without a mouse
|
||||
- [tmux-sidebar][tmux-sidebar]: directory tree for the current path
|
||||
- Usage of popups and fzf
|
||||
- Some defaults are now toggle modes, like sync or zoom
|
||||
- Simple true color theme
|
||||
- Compatible withe my environment config: [bashrc][bashrc_repo]
|
||||
- Plugins (included as submodules):
|
||||
- [tpm][tpm]: Plugin Manager.
|
||||
- [tmux-prefix-highlight][tmux-prefix-highlight]: highlights when you press tmux prefix key.
|
||||
- [tmux-menus][tmux-menus]: Popup menus.
|
||||
- [extrakto][extrakto]: quickly select, copy/insert/complete text without a mouse.
|
||||
- [tmux-sidebar][tmux-sidebar]: directory tree for the current path.
|
||||
- Usage of tmux popups & fzf.
|
||||
- Some defaults are now rewrittent as toggle modes, like sync or zoom.
|
||||
- Simple color theme with true colors.
|
||||
- Compatible with my environment config: [bashrc][bashrc_repo].
|
||||
- Check more in the conf file ...
|
||||
|
||||
## Requirements
|
||||
|
@ -39,7 +39,7 @@
|
|||
|
||||
## Installation
|
||||
|
||||
### Tmux
|
||||
### [Tmux][TMUX_repo]
|
||||
|
||||
- With APT:
|
||||
|
||||
|
@ -59,14 +59,14 @@ wget https://github.com/tmux/tmux/releases/download/3.3a/tmux-3.3a.tar.gz
|
|||
tar -zxf tmux-*.tar.gz
|
||||
cd tmux-*/
|
||||
./configure
|
||||
make && make install
|
||||
make && sudo make install
|
||||
```
|
||||
|
||||
### Gitmux
|
||||
### [Gitmux][gitmux_repo]
|
||||
|
||||
- Copy it manually to /usr/local/bin: https://github.com/arl/gitmux/releases
|
||||
|
||||
- Or you need jq to parse the latest release in cli:
|
||||
- Or you need `jq` to parse the latest release in cli:
|
||||
|
||||
```bash
|
||||
# for linux_amd64
|
||||
|
@ -76,7 +76,7 @@ _URL=$(echo "$_RELEASES" | jq -r '.assets[] | select( .name | match("linux_amd64
|
|||
wget -c -nv "$_URL" -O - | sudo tar --no-same-owner -xzv -C /usr/local/bin gitmux
|
||||
```
|
||||
|
||||
### Fzf
|
||||
### [Fzf][fzf_repo]
|
||||
|
||||
- With APT:
|
||||
|
||||
|
@ -99,7 +99,7 @@ sudo cp shell/completion.bash /etc/bash_completion.d/fzf
|
|||
sudo cp bin/* /usr/local/bin/
|
||||
```
|
||||
|
||||
### TmuxRC
|
||||
### [tmuxrc][tmuxrc_repo]
|
||||
|
||||
```bash
|
||||
# backup current files
|
||||
|
@ -107,6 +107,7 @@ mkdir -p $HOME/.backups
|
|||
cp -r --backup=t {"$HOME"/.tmux/,"$HOME"/.tmux,"$HOME"/.config/tmux/} $HOME/.backups/
|
||||
rm -Rf "$HOME"/.tmux/ "$HOME"/.tmux "$HOME"/.config/tmux/
|
||||
|
||||
# install
|
||||
mkdir -p $HOME/.config
|
||||
cd $HOME/.config
|
||||
git clone --depth=1 --recurse-submodules https://git.tkapias.net/tkapias/tmuxrc
|
||||
|
@ -116,9 +117,9 @@ git clone --depth=1 --recurse-submodules https://git.tkapias.net/tkapias/tmuxrc
|
|||
|
||||
### SSH/Remote
|
||||
|
||||
If you install this configuration on a remote system you want another prefix than on the local tmux (ctrl+x).
|
||||
If you install this configuration on a remote system, you will need another prefix than on the local tmux (ctrl+x).
|
||||
|
||||
You can change the prefix to ctrl+w on the remote like this:
|
||||
You can change the prefix to ctrl+w on the remote system like this:
|
||||
|
||||
```bash
|
||||
sed -i -e 's/C-x/C-w/g' -e 's/Ctrl-x/Ctrl-w/g' $HOME/.tmux.conf
|
||||
|
@ -134,6 +135,7 @@ sed -i -e 's/C-x/C-w/g' -e 's/Ctrl-x/Ctrl-w/g' $HOME/.tmux.conf
|
|||
[libevent_repo]: https://github.com/libevent/libevent/releases/latest
|
||||
[ncurses_repo]: https://invisible-mirror.net/archives/ncurses/
|
||||
[gitmux_repo]: https://github.com/arl/gitmux
|
||||
[fzf_repo]: https://github.com/junegunn/fzf.git
|
||||
[tpm]: https://github.com/tmux-plugins/tpm
|
||||
[tmux-prefix-highlight]: https://github.com/tmux-plugins/tmux-prefix-highlight
|
||||
[tmux-menus]: https://github.com/jaclu/tmux-menus
|
||||
|
|
Loading…
Reference in a new issue