Extend README

theHamsta · Nov 21, 2021 · bb8a9ec · bb8a9ec
1 parent b2f1378
commit bb8a9ec
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -11,3 +11,12 @@ require'nvim-semantic-tokens'.setup({
 ```
 
 Preset configurations are loaded from [./lua/nvim-semantic-tokens/presets](./lua/nvim-semantic-tokens/presets).
+The `"default"` preset will set the highlight groups described in [./doc/nvim-semantic-tokens.txt](./doc/nvim-semantic-tokens.txt).
+
+Use an autocommand for a filetype for which you have a language server set up that supports semantic tokens (e.g. clangd)
+
+```vim
+if &filetype == "cpp" || &filetype == "cuda" || &filetype == "c"
+  autocmd BufEnter,CursorHold,InsertLeave <buffer> lua require 'vim.lsp.buf'.semantic_tokens_full()
+endif
+```
diff --git a/doc/nvim-semantic-tokens.txt b/doc/nvim-semantic-tokens.txt
@@ -86,3 +86,5 @@ And the following highlight groups modifiers SemanticTokenModifiers:
   LspDocumentation
                                                             *hl-DefaultLibrary*
   LspDefaultLibrary
+
+vim:tw=78:ts=8:expandtab:noet:ft=help:norl: