1980ca091d
Also moved the templates out of this repository, and into the zimfw/install repo. This is a second big change after introducing the plugin mechanism. This makes installation and upgrading of Zim straightforward. Maybe the most important aspect of having the script in a single file is not having to manage "git repos inside git repos" (see #297), since the single file exists by itself and is not version-controlled (with git). I've implemented a two-stage sourcing of the file, so most of the file is only sourced when needed (namely when calling `zimfw` with any action other than `login-init`). The two-stage process is designed to avoid compromising the startup speed, which is our top priority. In an effort to help making the script maintainable, I've broken it into small ERB templates. This also adds the ability to pre-process the Zsh code with Ruby code. To build the script, use `make`.
122 lines
3.9 KiB
Markdown
122 lines
3.9 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] 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][blazing speed].
|
|
|
|
### Themes
|
|
|
|
To preview some of the available themes, check the [themes wiki page].
|
|
|
|
### Fish-shell history navigation
|
|
![history-substring-search]
|
|
|
|
### 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:
|
|
|
|
* With curl:
|
|
|
|
curl -fsSL https://raw.githubusercontent.com/zimfw/install/develop/install.zsh | zsh
|
|
|
|
* With wget:
|
|
|
|
wget -nv -O - 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] 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`.
|
|
|
|
[history-substring-search]: https://i.eriner.me/zim_history-substring-search.gif
|
|
[syntax-highlighting]: https://i.eriner.me/zim_syntax-highlighting.gif
|
|
[blazing speed]: https://github.com/zimfw/zimfw/wiki/Speed
|
|
[available modules]: https://github.com/zimfw/zimfw/wiki/Modules
|
|
[themes wiki page]: https://github.com/zimfw/zimfw/wiki/Themes
|