psi-jack/zimfw
1
0
Fork 0
mirror of synced 2024-12-23 14:33:21 -05:00
Code Issues Releases Wiki Activity
ZIM - Zsh IMproved FrameWork
zsh
98 commits 4 branches 35 tags 2.1 MiB
HTML 50%
Shell 49.9%
Makefile 0.1%
Find a file
Matt Hamilton fb7defa729 cleanup of zlogin 
Change the scope of the job: {} to (); removes need for unfunction

Because we changed the job scope, we no longer need the anonymous
function/local var.
2015-12-28 03:11:39 -05:00
modules not in a function; remove local 2015-12-28 01:56:07 -05:00
templates cleanup of zlogin 2015-12-28 03:11:39 -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 use consistent variable style 2015-12-19 09:48:29 -05:00
LICENSE add MIT License 2015-12-15 22:33:12 -05:00
README.md make template append explicitly clear 2015-12-22 11:12:06 -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.

Fish-shell History Navigation

history-substring-search

Syntax Highlighting

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.

  1. In a Zsh shell, clone the repository:
git clone --recursive https://github.com/Eriner/zim.git ${ZDOTDIR:-${HOME}}/.zim
  1. Paste this into your terminal to 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
  1. Set Zsh as the default shell:
chsh -s $(which zsh)
  1. Open a new terminal and finish optimization (this is only needed once, hereafter it will happen upon desktop/tty login):
source ${ZDOTDIR:-${HOME}}/.zlogin
  1. You're done! Enjoy your Zsh IMproved! Take some time to read about the available modules and tweak your .zshrc file.