diff --git a/README.md b/README.md index 9541858..5412778 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ ## Dotfiles -Dotfiles configurations for headless Kubuntu linux environments. Be sure to clone recursively if you want to grab updated plugins / submodules included. For example, using Pathogen with Vim to manage plugins requires that the plugin to be installed are cloned to the `~/.vim/bundle/` directory. Cloning recursively allows git to clone these same nested repositories/submodules within this directory so Pathogen can handle running the Vim plugins. +Dotfiles configurations for headless Kubuntu linux environments. Be sure to +clone recursively if you want to grab updated plugins / submodules included. For +example, using Pathogen with Vim to manage plugins requires that the plugin to +be installed are cloned to the `~/.vim/bundle/` directory. Cloning recursively +allows git to clone these same nested repositories/submodules within this +directory so Pathogen can handle running the Vim plugins. -Once installed, editing source code in vim supports features displayed in the screenshot below +Once installed, editing source code in vim supports features displayed in the +screenshot below ![Vim screenshot](VimScreenshot.png) @@ -29,3 +35,31 @@ docker build -t dot . docker run -it dot bash ``` +### Configurations + +| Plugin / Tool | Description | Repository | +|---------------------|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------| +| tmux | Terminal multiplexer configured within `.tmux.conf` and `.tmux.d/`. | [https://github.com/tmux/tmux](https://github.com/tmux/tmux) | +| tmux plugin manager | Manages tmux plugins directly from GitHub. | [https://github.com/tmux-plugins/tpm](https://github.com/tmux-plugins/tpm) | +| tmux-sensible | Provides improved sane defaults for tmux behavior and usability. | [https://github.com/tmux-plugins/tmux-sensible](https://github.com/tmux-plugins/tmux-sensible) | +| tmux-resurrect | Saves and restores tmux sessions, panes, and layouts between restarts. | [https://github.com/tmux-plugins/tmux-resurrect](https://github.com/tmux-plugins/tmux-resurrect) | +| tmux-continuum | Automatically saves tmux sessions and can restore them on system reboot. | [https://github.com/tmux-plugins/tmux-continuum](https://github.com/tmux-plugins/tmux-continuum) | +| xclip | Integrates tmux copy mode with the system clipboard under X11. | [https://github.com/astrand/xclip](https://github.com/astrand/xclip) | + +| Plugin | Description | Repository | +|--------------------|--------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| +| Colorizer | Highlights color codes in Vim buffers (useful for CSS/ web). | [https://github.com/chrisbra/Colorizer](https://github.com/chrisbra/Colorizer) | +| ALE | Asynchronous Lint Engine – linting & fixing in Vim asynchronously. | [https://github.com/dense-analysis/ale](https://github.com/dense-analysis/ale) | +| clang_complete | Auto-completion support for C/C++ using libclang. | [https://github.com/xavierd/clang_complete](https://github.com/xavierd/clang_complete) | +| supertab | Expand completions using `` in insert mode. | [https://github.com/ervandew/supertab](https://github.com/ervandew/supertab) | +| unicode.vim | Unicode helpers (insert and inspect Unicode characters). | [https://github.com/chrisbra/unicode.vim](https://github.com/chrisbra/unicode.vim) | +| vim-airline | Lean and fast status/tabline for Vim. | [https://github.com/vim-airline/vim-airline](https://github.com/vim-airline/vim-airline) | +| vim-airline-themes | Additional themes for vim-airline. | [https://github.com/vim-airline/vim-airline-themes](https://github.com/vim-airline/vim-airline-themes) | +| vim-signify | Shows VCS (git/hg) changes in the sign column. | [https://github.com/mhinz/vim-signify](https://github.com/mhinz/vim-signify) | + +| Tool / File | Description | Repository | +|----------------------|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| +| ranger | Terminal file manager with Vim-like keybindings & previews. | [https://github.com/ranger/ranger](https://github.com/ranger/ranger) | +| GNU Stow | Manages dotfiles by symlinking grouped configurations. | [https://www.gnu.org/software/stow/](https://www.gnu.org/software/stow/) | +| `.stow-local-ignore` | Specifies files/patterns for Stow to skip when linking. | [https://www.gnu.org/software/stow/manual/stow.html](https://www.gnu.org/software/stow/manual/stow.html) | +| `setup.sh` | Bootstrap script to automate initial symlinking and environment setup. | (Repository-local script) |