mirror of synced 2024-11-29 18:55:34 -05:00

ZIM - Zsh IMproved FrameWork

zsh

Find a file

Amin Bandali d395649113 Different prompt for privileged users Use `%(!.#.$)` which will display `$` for normal users and `#` for privileged users		2016-07-23 23:01:14 -04:00
.github	[github] move templates to .github dir	2016-05-14 15:27:25 -07:00
modules	Different prompt for privileged users	2016-07-23 23:01:14 -04:00
templates	[input] add double-dot expansion option	2016-05-20 20:25:04 -07: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	slight init refactor	2015-12-30 10:14:10 -05:00
LICENSE.md	use markdown MIT license	2016-02-18 00:04:06 -05:00
README.md	[README] remote note about AUR package	2016-06-12 11:10:36 -07: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. It can be installed manually by following the instructions below:

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}"
  touch ${user_file}
  ( print -rn "$(<${template_file})$(<${user_file})" >! ${user_file} ) 2>/dev/null
done

Set Zsh as the default shell:

chsh -s =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.