adam/zim
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
This repository has been archived on 2020-09-21. You can view files and clone it, but cannot push or open issues or pull requests.
105 Commits 1 Branch 0 Tags 236 KiB
Shell 100%
0f5ceab00a
Go to file
Matt Hamilton 0f5ceab00a Prepend, don't append to user configs 
We want to prepend the initialization of zim to any current user
configurations, not append. This way zim doesn't override any manually
configured settings in the user's config files.
2015-12-29 10:09:50 -05:00
modules fix bindkeys 2015-12-29 09:11:17 -05:00
templates disabling 'cursor' breaks color changes 2015-12-29 05:00:48 -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 Prepend, don't append to user configs 2015-12-29 10:09:50 -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
  user_file="${ZDOTDIR:-${HOME}}/.${${template_file}:t}"
  print -n "$(<${template_file})\n$(<${user_file})" >! ${user_file}
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.