zsh minimal modular mesmering prompt

Matt Hamilton d52993c70e add 'custom' module for easy customization 8 years ago
modules d52993c70e add 'custom' module for easy customization 8 years ago
templates b0bf9d2ebc load-time optimizations 8 years ago
.gitignore d52993c70e add 'custom' module for easy customization 8 years ago
.gitmodules 818beef89d add liquidprompt 8 years ago
LICENSE ac47c61167 add MIT License 8 years ago
README.md c4d607826c clarify install zsh shell 8 years ago
init.zsh a1a56ac63f use consistent variable style 8 years ago

README.md

ZIM - Zsh IMproved

What is Zim?

Zim is a Zsh configuration framework with blazing speed and modular extensions.

Zim is very easy to customize, and comes with a rich set of modules and features without compromising on speed or functionality!

What does Zim offer?

If you're here, it means you want to see the cool shit Zim can do. Check out the available modules!

Below is a brief showcase of Zim's features.

Speed

For a speed comparison between Zim and other frameworks, see this wiki entry.

Themes

To preview some of the available themes, check the themes wiki page.

Fish-shell History Navigation

history-substring-search

Syntax Highlighting

syntax-highlighting

And much more!

Zim has many modules! Enable as many or as few as you'd like.

Installation

Installing Zim is easy. If you have a different shell framework installed (like oh-my-zsh or prezto), uninstall those first to prevent conflicts.

  1. In a Zsh shell, clone the repository:

    git clone --recursive https://github.com/Eriner/zim.git ${ZDOTDIR:-${HOME}}/.zim
    
  2. Copy the template configuration files (or append to existing configs):

    setopt EXTENDED_GLOB
    for template_file ( ${ZDOTDIR:-${HOME}}/.zim/templates/* ); do
    cat ${template_file} | tee -a ${ZDOTDIR:-${HOME}}/.$(basename ${template_file}) > /dev/null
    done
    
  3. Set Zsh as the default shell:

    chsh -s $(which zsh)
    
  4. Open a new terminal and finish optimization (this is only needed once, hereafter it will happen upon desktop/tty login):

    source ${ZDOTDIR:-${HOME}}/.zlogin
    
  5. You're done! Enjoy your Zsh IMproved! Take some time to read about the available modules and tweak your .zshrc file.