a1291c5f28
Only 5% (18/342) of the themes listed under [unixorn/awesome-zsh-plugins]
are actually compatible with prompinit. Of these, [clean] also allows
being sourced directly. On the other hand, 3 others are prezto themes.
promptinit would be useful for who wants to try many themes without the
need to restart their shell session. And must be many many, so
"brute-force" starting a new shell to experiment each new theme would be
a burden! Even the cleanup feature of promptinit is still incomplete, so
you eventually get a messy prompt after trying many with it. And that's
not even a everyday use case of the average Zsh user.
So prompinit it not widely supported out there, and also not very useful
for the everyday let-me-use-my-beloved-and-carefully-customized-prompt-during-the-whole-shell-session-pleasee
scenario. It's also faster and simpler to directly just source the prompt
theme to be used, not even having to autoload promptinit and let it scan
all the others themes in fpath that won't be used.
And the Zim "philosophy" is to use fast and simple solutions.
So here we go.
Fixes #325
[unixorn/awesome-zsh-plugins]: e226f3de04/README.md (themes)
[clean]: https://github.com/BrandonRoehl/zsh-clean
115 lines
3.8 KiB
Markdown
115 lines
3.8 KiB
Markdown
Zsh IMproved FrameWork
|
|
======================
|
|
|
|
<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:
|
|
|
|
curl -s --proto -all,+https https://raw.githubusercontent.com/zimfw/install/develop/install.zsh | zsh
|
|
|
|
Open a new terminal and you're done! Enjoy your Zsh IMproved! Take some time to
|
|
read about the [available modules][modules] and tweak your `.zshrc` file.
|
|
|
|
If you have a different shell framework installed (like oh-my-zsh or prezto),
|
|
*uninstall those first to prevent conflicts*.
|
|
|
|
Settings
|
|
--------
|
|
|
|
### Enabled modules
|
|
|
|
Use the following zstyle to select the modules you would like enabled:
|
|
|
|
zstyle ':zim' modules 'first-module' 'second-module' 'third-module'
|
|
|
|
You can provide as many module names as you want. Modules are sourced in the
|
|
order given.
|
|
|
|
By default, a module is installed from the Zim repository with the same name.
|
|
For example, the `utility` module is installed from
|
|
https://<em></em>github.com/zimfw/utility.git if no additional module configuration is provided.
|
|
|
|
### Module customization
|
|
|
|
To configure a module, use the following format, where the style name is the
|
|
module name:
|
|
|
|
zstyle ':zim:module' <module> ['frozen' yes] ['url' <url>] ['branch' <branch>|'tag' <tag>]
|
|
|
|
| Key | Description | Default value |
|
|
| --- | ----------- | ------------- |
|
|
| frozen | If set to yes, then module will not be cleaned, installed or updated. It can still be freely enabled or disabled with the modules style. | no |
|
|
| url | Repository URL or path. The following formats are equivalent: *module*, zimfw/*module*, https://<em></em>github.com/zimfw/<em>module</em>.git | *module* |
|
|
| branch | Repository branch. | master |
|
|
| tag | Repository tag. Overrides branch, if one was specified. | |
|
|
|
|
Choose the module name wisely. The first file found in the module root directory,
|
|
in the following order, will be sourced:
|
|
init.zsh, *module*.zsh, *module*.plugin.zsh, *module*.zsh.theme, *module*.sh
|
|
|
|
For example, [mafredi/zsh-async](https://github.com/mafredri/zsh-async) must be
|
|
configured as a module called `async`:
|
|
|
|
zstyle ':zim:module' async 'url' 'mafredri/zsh-async'
|
|
|
|
because it has an async.zsh initialization file. Then to be enabled, `async` must
|
|
be added to the modules style.
|
|
|
|
Updating
|
|
--------
|
|
|
|
To update your modules, run:
|
|
|
|
zimfw update
|
|
|
|
To upgrade Zim, run:
|
|
|
|
zimfw upgrade
|
|
|
|
For more information about the `zimfw` tool, run `zimfw` with no parameters.
|
|
|
|
Uninstalling
|
|
------------
|
|
|
|
The best way to remove Zim is to manually delete `~/.zim`, `~/.zimrc`, and
|
|
remove the initialization lines from your `~/.zshrc` and `~/.zlogin`.
|
|
|
|
[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
|