psi-jack

zimfw

mirror of

ZIM - Zsh IMproved FrameWork

zsh

Go to file

Matt Hamilton e9703d14a5 re-word project page		2015-12-17 08:06:26 -05:00
modules	submodule repos ssh -> https	2015-12-17 05:24:31 -05:00
templates	update completion docs to reflect zmodules order	2015-12-17 03:06:12 -05:00
.gitignore	initial commit	2015-12-15 00:12:17 -05:00
.gitmodules	submodule repos ssh -> https	2015-12-17 05:24:31 -05:00
LICENSE	add MIT License	2015-12-15 22:33:12 -05:00
README.md	re-word project page	2015-12-17 08:06:26 -05:00
init.zsh	It is probably better to prepend ranther than append	2015-12-16 14:56:54 -05:00

README.md

ZIM - Zsh IMproved

What is Zim?

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

Zim is very easy to customize and add your own functionality. But worry not! You don't have to if that's not your cup of tea!

Zim comes with a rich set of default modules and features without comprimising 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.

Themes

Syntax Highlighting

Speed

For a speed comparison between zim and prezto, see this gist

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.

In Zsh, clone the repository:

git clone --recursive https://github.com/Eriner/zim.git ${ZDOTDIR:-$HOME}/.zim

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

Set Zsh as the default shell:

chsh -s $(which zsh)

Open a new terminal and admire your work!