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.
177 Commits 1 Branch 0 Tags 236 KiB
Shell 100%
d36d57e62a
Go to file
Matt Hamilton d36d57e62a [completion] add ${zcompdump_file} option 
This commit assumes that the user-provided variable for the filename
will start with '.zcomp'. This is used in the .zlogin for zcompiling the
completion file. Sourcing the .zimrc file within the .zlogin file is
something I'd rather not do, and this seems like a good compromise. If
this becomes an issue, the file can be sourced an the var can be used
instead.

Closes #42
2016-07-19 00:23:49 -04:00
modules [completion] add ${zcompdump_file} option 2016-07-19 00:23:49 -04:00
templates [completion] add ${zcompdump_file} option 2016-07-19 00:23:49 -04: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
ISSUE_TEMPLATE.md add issue and PR templates 2016-02-17 23:57:41 -05:00
LICENSE.md use markdown MIT license 2016-02-18 00:04:06 -05:00
PULL_REQUEST_TEMPLATE.md add issue and PR templates 2016-02-17 23:57:41 -05:00
README.md [README] create template file if it doesn't exist 2016-02-11 03:08:40 -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. Arch users can install zsh-zim-git from the AUR. It can be installed manually by following the instructions below:

  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 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 -n "$(<${template_file})\n$(<${user_file})" >! ${user_file} ) 2>/dev/null
done
  1. Set Zsh as the default shell:
chsh -s =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.