diff --git a/.screenshots/tmux.png b/.screenshots/tmux.png new file mode 100644 index 0000000..82e4b77 Binary files /dev/null and b/.screenshots/tmux.png differ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5b6d10e --- /dev/null +++ b/LICENSE @@ -0,0 +1,17 @@ +The MIT License (MIT) +Copyright © 2024 Chris Laprade (https://github.com/rootiest) +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the “Software”), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e2fe001 --- /dev/null +++ b/README.md @@ -0,0 +1,106 @@ +# Rootiest Tmux Configuration + +```none + ██▀███ ▒█████ ▒█████ ▄▄▄█████▓ ██▓▓█████ ██████ ▄▄▄█████▓ +▓██ ▒ ██▒▒██▒ ██▒▒██▒ ██▒▓ ██▒ ▓▒▓██▒▓█ ▀ ▒██ ▒ ▓ ██▒ ▓▒ +▓██ ░▄█ ▒▒██░ ██▒▒██░ ██▒▒ ▓██░ ▒░▒██▒▒███ ░ ▓██▄ ▒ ▓██░ ▒░ +▒██▀▀█▄ ▒██ ██░▒██ ██░░ ▓██▓ ░ ░██░▒▓█ ▄ ▒ ██▒░ ▓██▓ ░ +░██▓ ▒██▒░ ████▓▒░░ ████▓▒░ ▒██▒ ░ ░██░░▒████▒▒██████▒▒ ▒██▒ ░ +░ ▒▓ ░▒▓░░ ▒░▒░▒░ ░ ▒░▒░▒░ ▒ ░░ ░▓ ░░ ▒░ ░▒ ▒▓▒ ▒ ░ ▒ ░░ + ░▒ ░ ▒░ ░ ▒ ▒░ ░ ▒ ▒░ ░ ▒ ░ ░ ░ ░░ ░▒ ░ ░ ░ + ░░ ░ ░ ░ ░ ▒ ░ ░ ░ ▒ ░ ▒ ░ ░ ░ ░ ░ ░ + ░ ░ ░ ░ ░ ░ ░ ░ ░ + +░▒▓████████▓▒░▒▓██████████████▓▒░░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ + ░▒▓█▓▒░ ░▒▓█▓▒░░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ + ░▒▓█▓▒░ ░▒▓█▓▒░░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ + ░▒▓█▓▒░ ░▒▓█▓▒░░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░░▒▓██████▓▒░ + ░▒▓█▓▒░ ░▒▓█▓▒░░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ + ░▒▓█▓▒░ ░▒▓█▓▒░░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ + ░▒▓█▓▒░ ░▒▓█▓▒░░▒▓█▓▒░░▒▓█▓▒░░▒▓██████▓▒░░▒▓█▓▒░░▒▓█▓▒░ + + ▄████▄ ▒█████ ███▄ █ █████▒ + ▒██▀ ▀█ ▒██▒ ██▒ ██ ▀█ █ ▓██ ▒ + ▒▓█ ▄ ▒██░ ██▒▓██ ▀█ ██▒▒████ ░ + ▒▓▓▄ ▄██▒▒██ ██░▓██▒ ▐▌██▒░▓█▒ ░ + ▒ ▓███▀ ░░ ████▓▒░▒██░ ▓██░░▒█░ + ░ ░▒ ▒ ░░ ▒░▒░▒░ ░ ▒░ ▒ ▒ ▒ ░ + ░ ▒ ░ ▒ ▒░ ░ ░░ ░ ▒░ ░ + ░ ░ ░ ░ ▒ ░ ░ ░ ░ ░ + ░ ░ ░ ░ ░ + ░ + ╭─────────────╮ + ╭─────────────╮ + │ $W │ + │ │ + │ │ + ╰─────────────╯ +``` + +The rootiest Tmux configuration you will ever see! + +## Installation + +1. Install [Tmux](https://github.com/tmux/tmux) + +2. Backup your current Tmux configuration (if you have one) + + ```bash + mv ~/.config/tmux ~/.config/tmux.bak + mv ~/.tmux.conf ~/.tmux.conf.bak + ``` + +3. Clone the repository + + ```bash + git clone https://github.com/rootiest/rootiest-tmux.git ~/.config/tmux + ``` + +4. **Enjoy!** 🎉 + +## Features + +- Smart key bindings +- Leader key and modal mode +- Session mux/management/resurrection +- Advanced tab management +- Splits and panes integrate seamlessly with NeoVim +- Seamless integration with fish shell +- Catppuccin theme by default +- Integrates cleanly with other Rootiest projects + +## Screenshots + +![Rootiest Tmux](.screenshots/tmux.png) + +## Companion Tools + +[Rootiest WezTerm](https://github.com/rootiest/rootiest-wezterm) - +A wezterm configuration that is designed to work with this tmux config. + +[Rootiest Kitty](https://github.com/rootiest/rootiest-kitty) - +A kitty configuration that is designed to work with this tmux config. + +[Rootiest Fish](https://github.com/rootiest/rootiest-fish) - +Fish shell configuration that pairs well with this Tmux configuration +and the NeoVim configuration. + +[Rootiest Neovim](https://github.com/rootiest/rootiest-nvim) - +A NeoVim config built to work alongside this and the fish config. + +[Rootiest Iosevka Font](https://github.com/rootiest/rootiest-iosevka) - +A custom Iosevka font that is designed by developers, for developers. + +[Nerd Fonts](https://github.com/ryanoasis/nerd-fonts/) - +A collection of fonts that include many icons and glyphs that are used in this configuration. + +## Dotfiles + +[Rootiest Dotfiles](https://github.com/rootiest/dotfiles) + +## Credits + +- [wezterm](https://github.com/wez/wezterm) +- [resurrect.wezterm](https://github.com/MLFlexer/resurrect.wezterm) +- [smart-splits.nvim](https://github.com/mrjones2014/smart-splits.nvim) +- [wezterm-bar](https://github.com/nekowinston/wezterm-bar)