97 lines
2.7 KiB
Markdown
97 lines
2.7 KiB
Markdown
ZIM - Zsh IMproved
|
|
==================
|
|
|
|
<div align="center">
|
|
<a href="https://github.com/zimfw/zimfw">
|
|
<img width=650px src="https://i.eriner.me/zim_banner.png">
|
|
</a>
|
|
</div>
|
|
|
|
What is Zim?
|
|
------------
|
|
Zim is a Zsh configuration framework with [blazing speed][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][modules]!
|
|
|
|
Below is a brief showcase of Zim's features.
|
|
|
|
### Speed
|
|
For a speed comparison between Zim and other frameworks, see [this wiki entry][speed].
|
|
|
|
### Themes
|
|
|
|
To preview some of the available themes, check the [themes wiki page][themes].
|
|
|
|
### Fish-shell History Navigation
|
|
![history-substring-search][fish_shell]
|
|
|
|
### Syntax Highlighting
|
|
![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*. Then put following instructions at the end of your `~/.zshrc`:
|
|
|
|
```bash
|
|
# Zim initializition
|
|
export ZIM_HOME="$HOME/.zsh"
|
|
|
|
if [ ! -f "$ZIM_HOME/init.zsh" ]; then
|
|
echo "Installing zim"
|
|
git clone --recursive https://github.com/zimfw/zimfw.git $ZIM_HOME
|
|
cat $ZIM_HOME/templates/zlogin >> $HOME/.zlogin
|
|
source $HOME/.zlogin
|
|
fi
|
|
|
|
zmodules=(git git-info prompt completion syntax-highlighting autosuggestions fzf-zsh)
|
|
zprompt_theme='steeef'
|
|
zhighlighters=(main brackets cursor)
|
|
|
|
source $ZIM_HOME/init.zsh #make sure init after zmodules lists etcs..
|
|
```
|
|
|
|
You're done! Enjoy your Zsh IMproved! Take some time to read about the [available modules][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!**
|
|
|
|
|
|
[fish_shell]: https://i.eriner.me/zim_history-substring-search.gif
|
|
[syntax_highlighting]: https://i.eriner.me/zim_syntax-highlighting.gif
|
|
[speed]: https://github.com/zimfw/zimfw/wiki/Speed
|
|
[modules]: https://github.com/zimfw/zimfw/wiki/Modules
|
|
[themes]: https://github.com/zimfw/zimfw/wiki/Themes
|