1
0
Fork 0
mirror of synced 2024-11-26 17:25:35 -05:00
zimfw/README.md

65 lines
2.1 KiB
Markdown
Raw Normal View History

2015-12-15 00:12:17 -05:00
ZIM - Zsh IMproved
==================
Moving to Zsh because you heard it was cool? Tried other frameworks but found them slow?
Want something that works without spending hours configuring sane settings? Want to be the conqueror of shells?
Meet Zim.
What is Zim?
------------
Zim is a Zsh configuration fromework that prides itself on speed and modularity.
Zim is very easy to customize and add your own functionality. But worry not! You don't *have* to if that's not your cup of tea!
Zim comes with a rich set of default modules and features without comprimising on speed or functionality!
What does Zim offer?
-----------------
2015-12-16 18:00:14 -05:00
If you're here, it means you want to see the cool shit Zim can do. Check out the [available modules](https://github.com/Eriner/zim/wiki/Modules)!
Below is a brief showcase of Zim's features.
2015-12-15 00:12:17 -05:00
#### Themes
2015-12-15 00:43:33 -05:00
![Eriner Theme][theme_eriner]
2015-12-15 00:12:17 -05:00
#### Fish-shell History Navigation
2015-12-15 00:43:33 -05:00
![history-substring-search][fish_shell]
2015-12-15 00:12:17 -05:00
#### Syntax Highlighting
2015-12-15 00:43:33 -05:00
![syntax-highlighting][syntax_highlighting]
2015-12-15 00:12:17 -05:00
#### Speed
2015-12-15 00:43:33 -05:00
For a speed comparison between zim and prezto, see [this gist][zim_vs_prezto]
2015-12-15 00:12:17 -05:00
#### 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 Zsh, clone the repository:
```
git clone --recursive https://github.com/Eriner/zim.git ${ZDOTDIR:-$HOME}/.zim
```
2. Copy the template configuration files (or append to existing configs):
```
setopt EXTENDED_GLOB
for template_file ( ${ZDOTDIR:-$HOME}/.zim/templates/* ); do
cat ${template_file} | tee -a ${ZDOTDIR:-$HOME}/.$(basename ${template_file}) > /dev/null
done
```
3. Set Zsh as the default shell:
```
chsh -s $(which zsh)
```
4. Open a new terminal and admire your work!
2015-12-15 00:43:33 -05:00
[theme_eriner]: http://i.eriner.me/eriner_prompt_theme.png
[fish_shell]: http://i.eriner.me/zim_history-substring-search.gif
[syntax_highlighting]: http://i.eriner.me/zim_syntax-highlighting.gif
[zim_vs_prezto]: https://gist.github.com/Eriner/3aa88b161615c2913930