From cdac1666ee153d3526c72064d3559b9080058200 Mon Sep 17 00:00:00 2001 From: alker0 Date: Sun, 24 Sep 2023 09:34:42 +0900 Subject: [PATCH] doc(README): Mention `use_tmp_buffer` option In the `Install` section, tell that the `g:chezmoi#use_tmp_buffer` option is available and what good it will do. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 18cd333..078b4ec 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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