diff --git a/README.md b/README.md index 225daeb..dd9179d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,29 @@ -Git repo of my personal shell profile variables +## What this is +This is a Git repo of my personal shell profile and preferred working environment. You are free to use it if you think / work like me. + +## What does this do? + - works with the package manager to install my preferred tools + - use zsh by default + - enables oh-my-zsh with gentoo colors and the following plugins / settings + - git + - per-directory-history + - zsh-autosuggestions + - zsh-syntax-highlighting + - interactive comments + - `RM_STAR_WAIT` - wait 10 seconds before agreeing to rm * + - effectively unlimited history + - use phpenv, rbenv, pyenv, etc if installed + - vim as default editor with the following plugins / settings + - vim-fugitive + - vim-sleuth + - Vundle + - ignorecase / smartcase search + - `_` character counted as iskeyword + - all of the above with automation conveniences + - installer script, so i can run on any new PC / VM + - backs up current configs + - allows you to set local configs tracked separately from git + ## Installing ### Quick Install