mirror of synced 2024-11-12 11:08:58 -05:00

ZIM - Zsh IMproved FrameWork

zsh

Find a file

caedus75 9e767dd097 fix prompt substitutions/expansions The 'prompt' function disables any option set with 'setopt'. To make options persistent we need to use the 'prompt_opts' array instead		2015-12-30 05:01:49 -02:00
modules	fix prompt substitutions/expansions	2015-12-30 05:01:49 -02:00
templates	fix typo in zimrc template	2015-12-29 14:53:26 -05:00
.gitignore	add 'custom' module for easy customization	2015-12-22 05:55:48 -05:00
.gitmodules	add liquidprompt	2015-12-18 03:56:51 -05:00
init.zsh	unfunction loaders after use	2015-12-29 01:28:24 -05:00
LICENSE	add MIT License	2015-12-15 22:33:12 -05:00
README.md	remove unused link	2015-12-29 13:44:52 -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.

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.

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.

In a Zsh shell, clone the repository:

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

Paste this into your terminal to prepend the initialization templates to your configs:

setopt EXTENDED_GLOB
for template_file ( ${ZDOTDIR:-${HOME}}/.zim/templates/* ); do
  user_file="${ZDOTDIR:-${HOME}}/.${template_file:t}"
  ( print -n "$(<${template_file})\n$(<${user_file})" >! ${user_file} ) 2>/dev/null
done

Set Zsh as the default shell:

chsh -s $(which zsh)

Open a new terminal and finish optimization (this is only needed once, hereafter it will happen upon desktop/tty login):

source ${ZDOTDIR:-${HOME}}/.zlogin

You're done! Enjoy your Zsh IMproved! Take some time to read about the available modules and tweak your .zshrc file.