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.
zim/README.md

74 lines
2.3 KiB
Markdown
Raw Normal View History

2015-12-15 00:12:17 -05:00
ZIM - Zsh IMproved
==================
2015-12-17 07:44:19 -05:00
<div align="center">
<a href="http://github.com/Eriner/zim">
2015-12-17 11:04:01 -05:00
<img width=650px src="https://i.eriner.me/zim_banner.png">
2015-12-17 07:44:19 -05:00
</a>
</div>
2015-12-15 00:12:17 -05:00
What is Zim?
------------
2015-12-18 13:41:02 -05:00
Zim is a Zsh configuration framework with [blazing speed][speed] and modular extensions.
2015-12-17 08:06:26 -05:00
2015-12-18 07:40:11 -05:00
Zim is very easy to customize, and comes with a rich set of modules and features without compromising on speed or functionality!
2015-12-15 00:12:17 -05:00
What does Zim offer?
-----------------
2015-12-18 13:41:02 -05:00
If you're here, it means you want to see the cool shit Zim can do. Check out the [available modules][modules]!
2015-12-16 18:00:14 -05:00
Below is a brief showcase of Zim's features.
2015-12-15 00:12:17 -05:00
2015-12-18 13:41:02 -05:00
### Speed
For a speed comparison between Zim and other frameworks, see [this wiki entry][speed].
2015-12-18 13:34:24 -05:00
2015-12-18 13:41:02 -05:00
### Themes
2015-12-18 11:44:57 -05:00
To preview some of the available themes, check the [themes wiki page][themes].
2015-12-18 11:44:57 -05:00
2015-12-18 13:41:02 -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
2015-12-18 13:41:02 -05:00
### Syntax Highlighting
2015-12-15 00:43:33 -05:00
![syntax-highlighting][syntax_highlighting]
2015-12-15 00:12:17 -05:00
2015-12-18 13:41:02 -05:00
### And much more!
2015-12-15 00:12:17 -05:00
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)
```
2015-12-18 13:41:02 -05:00
4. Open a new terminal and finish optimization (this is only needed once, hereafter it will happen upon desktop/tty login):
```
source ~/.zlogin
```
5. You're done! Enjoy your Zsh IMproved! Take some time to read about the [available modules][modules] and tweak your `.zshrc` file.
2015-12-15 00:43:33 -05:00
2015-12-18 11:44:57 -05:00
[theme_minimal]: http://i.eriner.me/zim_prompt_minimal.png
2015-12-17 11:04:01 -05:00
[fish_shell]: https://i.eriner.me/zim_history-substring-search.gif
[syntax_highlighting]: https://i.eriner.me/zim_syntax-highlighting.gif
2015-12-18 13:41:02 -05:00
[speed]: https://github.com/Eriner/zim/wiki/Speed
[modules]: https://github.com/Eriner/zim/wiki/Modules
[themes]: https://github.com/Eriner/zim/wiki/Themes