aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Clason <c.clason@uni-graz.at>2022-01-24 16:14:26 +0100
committerChristian Clason <christian.clason@uni-due.de>2022-01-24 16:28:02 +0100
commit97ffd5c43dfddd95bfa76306cd1f7299ad9279b7 (patch)
treed87b6fc7344e42ff51f0e9fd49e3b059cd3608da
parentfeat(vim): highlight "higlight" variants (diff)
downloadnvim-treesitter-97ffd5c43dfddd95bfa76306cd1f7299ad9279b7.tar
nvim-treesitter-97ffd5c43dfddd95bfa76306cd1f7299ad9279b7.tar.gz
nvim-treesitter-97ffd5c43dfddd95bfa76306cd1f7299ad9279b7.tar.bz2
nvim-treesitter-97ffd5c43dfddd95bfa76306cd1f7299ad9279b7.tar.lz
nvim-treesitter-97ffd5c43dfddd95bfa76306cd1f7299ad9279b7.tar.xz
nvim-treesitter-97ffd5c43dfddd95bfa76306cd1f7299ad9279b7.tar.zst
nvim-treesitter-97ffd5c43dfddd95bfa76306cd1f7299ad9279b7.zip
doc: stress need to :TSUpdate after lockfile change
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 508e5868c..68d4fc828 100644
--- a/README.md
+++ b/README.md
@@ -71,10 +71,11 @@ For more detailed information on setting these up, see ["Advanced setup"](#advan
You can install `nvim-treesitter` with your favorite package manager (or using the native `package` feature of vim, see `:h packages`).
-E.g., if you are using [vim-plug](https://github.com/junegunn/vim-plug), put this in your `init.vim` file:
+**NOTE: This plugin is only guaranteed to work with specific versions of language parsers** (as specified in the `lockfile.json`). **When upgrading the plugin, you must make sure that all installed parsers are updated to the latest version** via `:TSUpdate`.
+It is strongly recommended to automate this; e.g., if you are using [vim-plug](https://github.com/junegunn/vim-plug), put this in your `init.vim` file:
```vim
-Plug 'nvim-treesitter/nvim-treesitter', {'do': ':TSUpdate'} " We recommend updating the parsers on update
+Plug 'nvim-treesitter/nvim-treesitter', {'do': ':TSUpdate'}
```
For other plugin managers such as `packer.nvim`, see this [Installation page from the wiki](https://github.com/nvim-treesitter/nvim-treesitter/wiki/Installation) (Note that this page is community maintained).
@@ -91,8 +92,7 @@ This command supports tab expansion.
You can also get a list of all available languages and their installation status with `:TSInstallInfo`.
Parsers not on this list can be added manually by following the steps described under ["Adding parsers"](#adding-parsers) below.
-If you update `nvim-treesitter` and want to make sure the parser is at the latest compatible version (as specified in `nvim-treesitter`'s `lockfile.json`), use `:TSUpdate {language}`.
-To update all parsers unconditionally, use `:TSUpdate all` or just `:TSUpdate`.
+To make sure a parser is at the latest compatible version (as specified in `nvim-treesitter`'s `lockfile.json`), use `:TSUpdate {language}`. To update all parsers unconditionally, use `:TSUpdate all` or just `:TSUpdate`.
## Modules