diff options
| author | Albert Cervin <albert@acervin.com> | 2024-09-12 20:46:42 +0200 |
|---|---|---|
| committer | Albert Cervin <albert@acervin.com> | 2024-09-12 20:46:42 +0200 |
| commit | edfb9bf03df4555bba520f47bea8db966d4c739e (patch) | |
| tree | fb1b3261ca6637a534c8ea64ef780cf3a93aeb48 /README.md | |
| parent | 405da5f84b072ea97b69359454899f45d92d24b6 (diff) | |
| download | dged-edfb9bf03df4555bba520f47bea8db966d4c739e.tar.gz dged-edfb9bf03df4555bba520f47bea8db966d4c739e.tar.xz dged-edfb9bf03df4555bba520f47bea8db966d4c739e.zip | |
Update the expectations on grammars
Outside the Nix setup, it will be the responsibility of something else
(might be a script) to provide the treesitter grammars.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 20 insertions, 2 deletions
@@ -21,7 +21,7 @@ expected pre-1.0.0. - [x] Terminal only - [x] Mouse-free editing - [x] Naive and incorrect unicode handling -- [ ] LSP Client implementation +- [ ] LSP Client implementation (in progress) ## Contributing @@ -41,7 +41,25 @@ needed dependencies, issue: $ nix develop ``` -Currently, tree-sitter grammars can only be automatically fetched when using the Nix setup. +Tree-sitter grammars are automatically fetched and bundled when using the Nix setup. +When not using the Nix setup, download/build needed treesitter grammars and set the env +var $BUNDLE_TREESITTER_GRAMMARS to a folder containing built treesitter grammars. The +structure should be like + +``` +/ + <lang-1>/ + parser # the parser binary as a DSO + queries/ + highlights.scm # treesitter queries for highlights + <lang-2>/ + parser + queries/ + highlights.scm + ... +``` + +where `<lang-1>` is for example `cpp` which corresponds to the language id, see man page. To build the editor, first create the build folder |
