1
0
Fork 0
mirror of synced 2024-11-13 19:48:58 -05:00
zimfw/README.md
Jorrit Visser 603a6f79c7 Install via script instead of manual steps
What it says in the title, makes installs much, much easier.
2017-05-20 17:29:40 +02:00

2.4 KiB

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. Just run one of these commands:

via curl

sh -c "$(curl -fsSL --proto-redir -all,https https://raw.githubusercontent.com/Eriner/zim/master/tools/zim_install)"

via wget

sh -c "$(wget -q --secure-protocol=auto https://raw.githubusercontent.com/Eriner/zim/master/tools/zim_install) -O -)"

That's all there is to it. 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, see the meta module documentation.

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!