Skip to content

Commit

Permalink
doc(README): Mention use_tmp_buffer option
Browse files Browse the repository at this point in the history
In the `Install` section, tell that the `g:chezmoi#use_tmp_buffer`
option is available and what good it will do.
  • Loading branch information
alker0 committed Sep 24, 2023
1 parent 0512b03 commit cdac166
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,14 @@ Furthermore, **with keeping original highlighting**, this plugin applies that of

# Install

:warning: Notes: You must load this plugin before the following timings:
:warning: You must load this plugin before the following timings:
* Calling `filetype on`, `syntax enable` or `syntax on`
* Loading other plugins that include `filetype.vim`
* End of `vimrc`
* End of `init.vim` if you use neovim

However enabling the `g:chezmoi#use_tmp_buffer` experimental option makes you free from the above limitation (see the [Options section](#options) for more details).

If you use [Vim 8 packages](http://vimhelp.appspot.com/repeat.txt.html#packages):
```sh
$ git clone https://github.com/alker0/chezmoi.vim ~/.vim/pack/plugins/opt/chezmoi.vim
Expand All @@ -53,7 +55,7 @@ And then insert this line your `vimrc` with taking the above notes into consider
packadd chezmoi.vim
```

You can also use the favorite plugin manager, in that case, make your plugin manager load this plugin earlier than others. You must **not** load this plugin lazily.
You can also use the favorite plugin manager but you must **not** load this plugin lazily for detecting filetype correctly. You also have to load `chezmoi.vim` earlier than others unless you enable the `g:chezmoi#use_tmp_buffer` option.

# Usage

Expand Down

0 comments on commit cdac166

Please sign in to comment.