mirror of synced 2024-12-22 22:18:57 -05:00

ZIM - Zsh IMproved FrameWork

zsh

Find a file

Matt Hamilton 5cf08f503f add minimal prompt		2015-12-18 10:51:58 -05:00
modules	add minimal prompt	2015-12-18 10:51:58 -05:00
templates	eriner prompt requires fonts; use steeef	2015-12-18 10:13:38 -05:00
.gitignore	initial commit	2015-12-15 00:12:17 -05:00
.gitmodules	add liquidprompt	2015-12-18 03:56:51 -05:00
init.zsh	It is probably better to prepend ranther than append	2015-12-16 14:56:54 -05:00
LICENSE	add MIT License	2015-12-15 22:33:12 -05:00
README.md	fix typos and structure	2015-12-18 07:40:58 -05:00

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.

Themes

Syntax Highlighting

Speed

For a speed comparison between zim and other frameworks, 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!