samba/zim
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
zim/README.md

99 lines
2.8 KiB
Markdown
Raw Normal View History

Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
Zsh IMproved FrameWork
======================
initial commit
2015-12-15 06:12:17 +01:00
Add logo
2015-12-17 13:44:19 +01:00
<div align="center">
Update to new repo URL from `Eriner/zim` to the new `zimfw/zimfw`. Closes #238
2018-01-01 13:58:41 +01:00
<a href="https://github.com/zimfw/zimfw">
update i.eriner.me links to https
2015-12-17 17:04:01 +01:00
<img width=650px src="https://i.eriner.me/zim_banner.png">
Add logo
2015-12-17 13:44:19 +01:00
</a>
</div>
initial commit
2015-12-15 06:12:17 +01:00
What is Zim?
------------
update link format
2015-12-18 19:41:02 +01:00
Zim is a Zsh configuration framework with [blazing speed][speed] and modular extensions.
re-word project page
2015-12-17 14:06:26 +01:00
fix typos and structure
2015-12-18 13:40:11 +01:00
Zim is very easy to customize, and comes with a rich set of modules and features without compromising on speed or functionality!
initial commit
2015-12-15 06:12:17 +01:00
What does Zim offer?
-----------------
update link format
2015-12-18 19:41:02 +01:00
If you're here, it means you want to see the cool shit Zim can do. Check out the [available modules][modules]!
add link to modules wiki article
2015-12-17 00:00:14 +01:00
Below is a brief showcase of Zim's features.
initial commit
2015-12-15 06:12:17 +01:00
update link format
2015-12-18 19:41:02 +01:00
### Speed
For a speed comparison between Zim and other frameworks, see [this wiki entry][speed].
link to speed wiki entry
2015-12-18 19:34:24 +01:00
update link format
2015-12-18 19:41:02 +01:00
### Themes
add theme images
2015-12-18 17:44:57 +01:00
re-organize themes section, remove image
2015-12-18 19:46:16 +01:00
To preview some of the available themes, check the [themes wiki page][themes].
add theme images
2015-12-18 17:44:57 +01:00
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
### Fish-shell history navigation
add gifs and images to README.md
2015-12-15 06:43:33 +01:00
![history-substring-search][fish_shell]
initial commit
2015-12-15 06:12:17 +01:00
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
### Syntax highlighting
add gifs and images to README.md
2015-12-15 06:43:33 +01:00
![syntax-highlighting][syntax_highlighting]
initial commit
2015-12-15 06:12:17 +01:00
update link format
2015-12-18 19:41:02 +01:00
### And much more!
initial commit
2015-12-15 06:12:17 +01: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),
[README] remote note about AUR package This package is causing issues, and editing Zim to allow for use in this 'packaged' format would be a pain. Installing into your home directory is the best method of installation.
2016-06-12 20:10:31 +02:00
*uninstall those first to prevent conflicts*. It can be installed manually by following the instructions below:
initial commit
2015-12-15 06:12:17 +01:00
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
1. Start a Zsh shell:
initial commit
2015-12-15 06:12:17 +01:00
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
zsh
initial commit
2015-12-15 06:12:17 +01:00
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
2. Clone the repository:
initial commit
2015-12-15 06:12:17 +01:00
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
git clone --recursive https://github.com/zimfw/zimfw.git ${ZDOTDIR:-${HOME}}/.zim
update link format
2015-12-18 19:41:02 +01:00
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
3. 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
4. Set Zsh as the default shell:
chsh -s =zsh
5. Open a new terminal and finish optimization (this is only needed once, hereafter it will happen upon desktop/tty login):
source ${ZDOTDIR:-${HOME}}/.zlogin
6. You're done! Enjoy your Zsh IMproved! Take some time to read about the [available modules][modules] and tweak your `.zshrc` file.
add gifs and images to README.md
2015-12-15 06:43:33 +01:00
[Readme] add update and removal notes Closes #50
2016-09-06 00:36:44 +02:00
Updating
--------
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
To update Zim, run:
[Readme] add update and removal notes Closes #50
2016-09-06 00:36:44 +02:00
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
zmanage update
[Readme] add update and removal notes Closes #50
2016-09-06 00:36:44 +02:00
Remove old link to meta module in README Meta module was removed in e0a7c67 Closes #255
2018-04-03 15:52:04 +02:00
For more information about the `zmanage` tool, run `zmanage help`.
[Readme] add update and removal notes Closes #50
2016-09-06 00:36:44 +02:00
Uninstalling
------------
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
The best way to remove Zim is to manually delete `~/.zim`, `~/.zimrc`, and
remove the initialization lines from your `~/.zshrc` and `~/.zlogin`.
[Readme] add update and removal notes Closes #50
2016-09-06 00:36:44 +02:00
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
However, there are some **experimental** convenience functions to remove Zim:
[Readme] add update and removal notes Closes #50
2016-09-06 00:36:44 +02:00
**NOTE: This functionality is experimental!**
Update README.md instructions and formatting Add a first step to explicitly start the Zsh shell, as some issues were reported before because users were skipping this. See #214 for example. Also mention `~/.zlogin` as part of the uninstalling process. Use the following formatting styles: * Headers >1 are in `Sentence case`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer code indented with 4 spaces instead of ``` code fenced by lines with three back-ticks ``` Closes #315
2018-12-12 16:40:23 +01:00
To remove Zim, run:
zmanage remove
[Readme] add update and removal notes Closes #50
2016-09-06 00:36:44 +02:00
**NOTE: This functionality is experimental!**
update i.eriner.me links to https
2015-12-17 17:04:01 +01:00
[fish_shell]: https://i.eriner.me/zim_history-substring-search.gif
[syntax_highlighting]: https://i.eriner.me/zim_syntax-highlighting.gif
Update to new repo URL from `Eriner/zim` to the new `zimfw/zimfw`. Closes #238
2018-01-01 13:58:41 +01:00
[speed]: https://github.com/zimfw/zimfw/wiki/Speed
[modules]: https://github.com/zimfw/zimfw/wiki/Modules
[themes]: https://github.com/zimfw/zimfw/wiki/Themes
Reference in a new issue Copy permalink