1
0
Fork 0
mirror of synced 2024-11-03 00:18:57 -04:00

Update README.md with automatic installer

Also change formatting of the settings. Using `<em></em>` to prevent
URL autolinking in some cases, and to add emphasis where `*foo*` would
be ambiguous for the Markdown format.

Copy was also slightly improved, hopefully for better clarity.
This commit is contained in:
Eric Nielsen 2019-01-10 19:59:04 -05:00
parent 8dc3e43a0d
commit 2a51211ab7
No known key found for this signature in database
GPG key ID: 47D1DBFA0765A1FB

View file

@ -37,39 +37,15 @@ Zim has many modules! Enable as many or as few as you'd like.
Installation Installation
------------ ------------
Installing Zim is easy. If you have a different shell framework installed (like oh-my-zsh or prezto), Installing Zim is easy:
*uninstall those first to prevent conflicts*. It can be installed manually by following the instructions below:
1. Start a Zsh shell: curl -s --proto -all,+https https://raw.githubusercontent.com/zimfw/install/develop/install.zsh | 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.
2. Clone the repository: If you have a different shell framework installed (like oh-my-zsh or prezto),
*uninstall those first to prevent conflicts*.
git clone --recursive https://github.com/zimfw/zimfw.git ${ZDOTDIR:-${HOME}}/.zim
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}.tmp && mv ${user_file}{.tmp,}
done
4. Set Zsh as the default shell:
chsh -s =zsh
5. Open a new terminal and install the enabled modules.
zimfw install
6. Finish optimization (this is only needed once, hereafter it will happen upon
desktop/tty login):
zimfw login-init
7. You're done! Enjoy your Zsh IMproved! Take some time to read about the
[available modules][modules] and tweak your `.zshrc` file.
Settings Settings
-------- --------
@ -84,54 +60,49 @@ You can provide as many module names as you want. Modules are sourced in the
order given. order given.
By default, a module is installed from the Zim repository with the same name. By default, a module is installed from the Zim repository with the same name.
For example, the `git` module is installed from https://github.com/zimfw/git if For example, the `utility` module is installed from
no additional module configuration is provided. https://<em></em>github.com/zimfw/utility.git if no additional module configuration is provided.
### Module customization ### Module customization
To configure a module, use the following format (where the style name is the To configure a module, use the following format, where the style name is the
module name): module name:
zstyle ':zim:module' <module> ['frozen' yes] ['url' <url>] ['branch' <branch>|'tag' <tag>] zstyle ':zim:module' <module> ['frozen' yes] ['url' <url>] ['branch' <branch>|'tag' <tag>]
If `frozen` is set to `yes`, then the module will not be cleaned, installed or | Key | Description | Default value |
updated. | --- | ----------- | ------------- |
| 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 |
You can provide a custom `url` with the following equivalent formats: | url | Repository URL or path. The following formats are equivalent: *module*, zimfw/*module*, https://<em></em>github.com/zimfw/<em>module</em>.git | *module* |
* `module` | branch | Repository branch. | master |
* `zimfw/module` | tag | Repository tag. Overrides branch, if one was specified. | |
* `https://github.com/zimfw/module.git`
If no `branch` or `tag` name is given, then the default is `branch` `master`.
Choose the module name wisely. The first file found in the module root directory, Choose the module name wisely. The first file found in the module root directory,
in the following order, will be sourced (where `module` is the module name): in the following order, will be sourced:
1. `init.zsh` init.zsh, *module*.zsh, *module*.plugin.zsh, *module*.zsh.theme, *module*.sh
2. `module.zsh`
3. `module.plugin.zsh`
4. `module.zsh.theme`
5. `module.sh`
For example, https://github.com/mafredri/zsh-async must be configured as: 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' zstyle ':zim:module' async 'url' 'mafredri/zsh-async'
because it has a `async.zsh` initialization file, then enabled as `async` in the because it has an async.zsh initialization file. Then to be enabled, `async` must
`modules` style. be added to the modules style.
### Prompt theme ### Prompt theme
Prompt themes are enabled in one of two different ways, depending on how the Prompt themes are enabled in one of two different ways, depending on how the
specific theme you want works: specific theme you want works:
1. If it has a `prompt_module_setup` file (where `module` is the module name): 1. If it has a prompt_<em>module</em>_setup file: it is enabled with Zim's
it is enabled with Zim's `prompt` module. See [the instructions `prompt` module. See [the instructions
here](https://github.com/zimfw/prompt/blob/master/README.md#settings). The here](https://github.com/zimfw/prompt/blob/master/README.md#settings). All
advantage of these themes is that you can customize them with additional [Zim themes](https://github.com/zimfw/zimfw/wiki/Themes) work this way.
parameters. All [Zim themes](https://github.com/zimfw/zimfw/wiki/Themes) The advantage of these themes is that you can customize them with
work this way. additional parameters.
2. If it has one of the initialization files listed above: it is enabled when 2. If it has one of the initialization files listed above: it is enabled when
it's sourced, not with Zim's `prompt` module. it's sourced, not with Zim's `prompt` module. The last sourced prompt
overrides any previous ones.
Updating Updating
-------- --------