psi-jack/zimfw
1
0
Fork 0
mirror of synced 2024-11-26 09:15:34 -05:00
Code Issues Releases Wiki Activity
ZIM - Zsh IMproved FrameWork
zsh
398 commits 4 branches 35 tags 2.1 MiB
HTML 50%
Shell 49.9%
Makefile 0.1%
Find a file
Eric Nielsen d74ceedef7 Generic approach for zrecompiling scripts 
* create digest of scripts in a `functions` directory that don't start
  with `_` (completion functions) and that don't have a `.` (function
  names cannot have that character)
* zrecompile any `.zsh` or `.zsh-theme` file that is not in a `*test*`
  directory (see 2a9a003), and that is a plain file with more than 1K of
  size.

instead of the fixed logic that was zrecompiling syntax-highlighting and
history-substring-search modules' scripts.

Closes #260
2018-04-09 18:09:07 -05:00
.github Update to new repo URL 2018-01-03 10:30:12 -05:00
modules [git] Remove extra line break from graph logs 2018-04-09 12:07:37 -05:00
templates [meta] Move zmanage to function in init.zsh 2017-11-24 19:08:39 -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 Change order or module loading system 2018-04-05 08:24:17 -05:00
LICENSE.md use markdown MIT license 2016-02-18 00:04:06 -05:00
login_init.zsh Generic approach for zrecompiling scripts 2018-04-09 18:09:07 -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.

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. It can be installed manually by following the instructions below:

  1. In a Zsh shell, clone the repository:
git clone --recursive https://github.com/zimfw/zimfw.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 -rn "$(<${template_file})$(<${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.

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

NOTE: This functionality is experimental!