1
0
Fork 0
mirror of synced 2024-07-16 06:36:43 -04:00
zimfw/README.md

145 lines
4.7 KiB
Markdown
Raw Normal View History

2015-12-17 07:44:19 -05:00
<div align="center">
<a href="https://github.com/zimfw/zimfw">
<img width="650" src="https://zimfw.github.io/images/zim_banner.png">
2015-12-17 07:44:19 -05:00
</a>
</div>
2020-01-13 12:24:43 -05:00
Zsh IMproved FrameWork
======================
2015-12-15 00:12:17 -05:00
What is Zim?
------------
Zim is a Zsh configuration framework with [blazing 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?
-----------------
If you're here, it means you want to see the cool shit Zim can do. Check out the [available 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][blazing 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].
2015-12-18 11:44:57 -05:00
### Fish-shell history navigation
![history-substring-search]
2015-12-15 00:12:17 -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:
2015-12-15 00:12:17 -05:00
* With curl:
curl -fsSL https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh
* With wget:
wget -nv -O - https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh
2015-12-15 00:12:17 -05:00
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.
2015-12-15 00:12:17 -05:00
If you have a different shell framework installed (like oh-my-zsh or prezto),
*uninstall those first to prevent conflicts*.
2019-12-04 07:22:17 -05:00
### Manual installation
1. Start a Zsh shell
2019-12-04 07:22:17 -05:00
zsh
2019-12-04 07:22:17 -05:00
2. Set Zsh as the default shell:
2019-12-04 07:22:17 -05:00
chsh -s =zsh
2019-12-04 07:22:17 -05:00
3. Copy https://github.com/zimfw/zimfw/releases/latest/download/zimfw.zsh to
`~/.zim/zimfw.zsh`.
2019-12-04 07:22:17 -05:00
4. Add the lines in the following templates to the respective dot files:
* [~/.zshenv](https://github.com/zimfw/install/blob/master/src/templates/zshenv)
* [~/.zshrc](https://github.com/zimfw/install/blob/master/src/templates/zshrc)
* [~/.zlogin](https://github.com/zimfw/install/blob/master/src/templates/zlogin)
* [~/.zimrc](https://github.com/zimfw/install/blob/master/src/templates/zimrc)
2019-12-04 07:22:17 -05:00
5. Install the modules defined in `~/.zimrc` and build the initialization scripts:
2019-12-04 07:22:17 -05:00
source ~/.zim/zimfw.zsh install
2019-12-04 07:22:17 -05:00
Usage
-----
### zmodule
Add `zmodule` calls to your `~/.zimrc` file to define the modules to be initialized.
The modules are initialized in the same order they are defined. Add:
zmodule <url> [-n|--name <module_name>] [options]
where `<url>` is the required repository URL or path. The following formats
2019-12-04 07:22:17 -05:00
are equivalent: `name`, `zimfw/name`, `https://github.com/zimfw/name.git`.
By default, the module name is the last component in the `<url>`. Use the
`-n|--name <module_name>` option to set a custom module name.
Repository options:
* `-b|--branch <branch_name>`: Use specified branch when installing and
2019-12-04 07:22:17 -05:00
updating the module. Overrides the tag option. Default: `master`.
* `-t|--tag <tag_name>`: Use specified tag when installing and updating the
2019-12-04 07:22:17 -05:00
module. Overrides the branch option.
* `-z|--frozen`: Don't install or update the module.
Initialization options:
* `-f|--fpath <path>`: Add specified path to `fpath`. The path is relative to
2019-12-04 07:22:17 -05:00
the module root directory. Default: `functions`, if the subdirectory exists.
* `-a|--autoload <function_name>`: Autoload specified function. Default: all
valid names inside the module's specified `fpath` paths.
* `-s|--source <file_path>`: Source specified file. The file path is relative
2019-12-04 07:22:17 -05:00
to the module root directory. Default: the file with largest size matching
`{init.zsh|module_name.{zsh|plugin.zsh|zsh-theme|sh}}`, if any exists.
* `-d|--disabled`: Don't initialize or uninstall the module.
### zimfw
Added new modules to `~/.zimrc`? Run `zimfw install`.
Removed modules from `~/.zimrc`? Run `zimfw uninstall`.
Want to update your modules to their latest revisions? Run `zimfw update`.
Want to upgrade `zimfw` to its latest version? Run `zimfw upgrade`.
For more information about the `zimfw` tool, run `zimfw help`.
Settings
--------
By default, every 30 days `zimfw` will check if it has a new version available.
This can be disabled with:
zstyle ':zim' disable-version-check yes
Uninstalling
------------
The best way to remove Zim is to manually delete `~/.zim`, `~/.zimrc`, and
remove the initialization lines from your `~/.zshenv`, `~/.zshrc` and `~/.zlogin`.
[history-substring-search]: https://zimfw.github.io/images/zim_history-substring-search.gif
[syntax-highlighting]: https://zimfw.github.io/images/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