Skip to content

Commit

Permalink
docs(readme/treesitter): add not about rocks-binaries
Browse files Browse the repository at this point in the history
  • Loading branch information
mrcjkb committed Mar 13, 2024
1 parent 34996d8 commit e4296da
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,21 @@ for luarocks, ensuring a seamless and efficient user experience.

[^1]: We only upload parsers which we can install in the NURR CI.

When installing, rocks.nvim will also search our [rocks-binaries](https://nvim-neorocks.github.io/rocks-binaries/)
server, which means you don't even need to compile many parsers
on your machine[^2].

[^2]: We currently do not provide binary rocks for parsers that need
to have their sources generated using the tree-sitter CLI.

### Simplifying dependencies

For plugin developers, specifying a tree-sitter parser as a dependency
is now as straightforward as including it in their project's rockspec[^2].
is now as straightforward as including it in their project's rockspec[^3].
This eliminates the need for manual parser management and ensures that
dependencies are automatically resolved and installed.

[^2]: [example](https://luarocks.org/modules/MrcJkb/neotest-haskell).
[^3]: [example](https://luarocks.org/modules/MrcJkb/neotest-haskell).

Example rockspec dependency specification:

Expand Down

0 comments on commit e4296da

Please sign in to comment.