mirror of synced 2024-11-22 15:25:34 -05:00

ZIM - Zsh IMproved FrameWork

zsh

Find a file

Eric Nielsen 4acd1b8533 Update comments in zimrc template mainly to change "command correction prompts" to "spelling correction prompt for commands" and make it clear that this is related to spelling (and to the `SPROMPT` below that).		2018-04-24 08:59:58 -05:00
.github	Update to new repo URL	2018-01-03 10:30:12 -05:00
modules	[input] We also need the echoti feature of zsh/terminfo	2018-04-18 17:24:48 -05:00
templates	Update comments in zimrc template	2018-04-24 08:59:58 -05:00
tools	Update to new repo URL	2018-01-03 10:30:12 -05:00
.gitignore	Ignore *.zwc.old files when compiling functions	2017-11-24 19:08:39 -05:00
.gitmodules	[autosuggestions] Add module	2017-06-08 09:33:26 -05:00
init.zsh	Use bindkey instead of set -o	2018-04-19 12:32:56 -05:00
LICENSE.md	use markdown MIT license	2016-02-18 00:04:06 -05:00
login_init.zsh	Also still not zrecompile prompt_*_setup files	2018-04-09 18:12:34 -05:00
README.md	Remove old link to meta module in README	2018-04-03 08:52:04 -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. It can be installed manually by following the instructions below:

In a Zsh shell, clone the repository:

git clone --recursive https://github.com/zimfw/zimfw.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.

Updating

To update zim, run:

zmanage update

For more information about the zmanage tool, run zmanage help.

Uninstalling

The best way to remove zim is to manually delete ~/.zim, ~/.zimrc, and remove the initialization lines from your ~/.zshrc.

However, there are some experimental convenience functions to remove zim:

NOTE: This functionality is experimental!

To remove zim, run:

zmanage remove