mirror of synced 2024-11-22 15:25:34 -05:00

ZIM - Zsh IMproved FrameWork

zsh

Find a file

Eric Nielsen af11392473 [history] Remove EXTENDED_HISTORY and INC_APPEND_HISTORY as they are not required (not even recommended) to be set along with `SHARE_HISTORY`. See zshoptions(1) on `SHARE_HISTORY`: > This option ... also causes your typed commands to be appended to the > history file (the latter is like specifying `INC_APPEND_HISTORY`, > which should be turned off if this option is in effect). The history > lines are also output with timestamps ala `EXTENDED_HISTORY` ... Also update copy in comments and in the README. Stick with the following style for the README: * Header 1 with the module name is in `lowercase`. * Other headers are in `Sentence case`. Common header names that should be consistently used are `Aliases`, `Functions`, `Settings`, and `Zsh options`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. Closes #313		2018-12-15 08:10:29 -05:00
.github	Update to new repo URL	2018-01-03 10:30:12 -05:00
modules	[history] Remove EXTENDED_HISTORY and INC_APPEND_HISTORY	2018-12-15 08:10:29 -05:00
templates	Use cat to concatenate files in installation	2018-11-21 11:58:30 -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	Don't track new files in submodules from main repo	2018-11-26 22:12:49 -05:00
init.zsh	Unify the `for` syntax	2018-04-25 08:59:19 -05:00
LICENSE.md	use markdown MIT license	2016-02-18 00:04:06 -05:00
login_init.zsh	Unify the `for` syntax	2018-04-25 08:59:19 -05:00
README.md	Update README.md instructions and formatting	2018-12-15 07:58:03 -05:00

README.md

Zsh IMproved FrameWork

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.

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:

Start a Zsh shell:
```
zsh
```

Clone the repository:

git clone --recursive https://github.com/zimfw/zimfw.git ${ZDOTDIR:-${HOME}}/.zim

Paste this into your terminal to prepend the initialization templates to your configs:

for template_file in ${ZDOTDIR:-${HOME}}/.zim/templates/*; do
  user_file="${ZDOTDIR:-${HOME}}/.${template_file:t}"
  cat ${template_file} ${user_file}(.N) >! ${user_file}
done

Set Zsh as the default shell:
```
chsh -s =zsh
```
Open a new terminal and finish optimization (this is only needed once, hereafter it will happen upon desktop/tty login):
```
source ${ZDOTDIR:-${HOME}}/.zlogin
```
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 and ~/.zlogin.

However, there are some experimental convenience functions to remove Zim:

NOTE: This functionality is experimental!

To remove Zim, run:

zmanage remove