search

p00f / nvim-ts-rainbow

Rainbow parentheses for neovim using tree-sitter. Use https://sr.ht/~p00f/nvim-ts-rainbow instead
Apache License 2.0
869 stars 67 forks source link

Update readme to mention how to install #134

Closed glenpereira closed 2 years ago

glenpereira commented 2 years ago

I might be a newbie but if the present docs mentioned how to install the module then that would've been great.

I spent way too much time trying to figure out how to install a treesitter module (~1.5hours) that I think I might not be the only one to face this issue in the future (especially for beginners like me). I thought installing nvim-ts-rainbow had something to do with the adding modules function specified here. I finally got it by reading this article.

A simple mention of use 'p00f/nvim-ts-rainbow' and then adding the rainbow{} config would've been better, as the 'install plugin then add call' phrase is too confusing.

Again I've only started dabbling in the neovim world for the past few days so take my opinion with a grain of salt.

p00f commented 2 years ago

Install and set up nvim-treesitter according to their documentation. Install this plugin, then add a rainbow section in the call to require("nvim-treesitter.configs").setup():

I think "install this plugin" is clear enough.

use 'p00f/nvim-ts-rainbow'

There are other plugin/package managers, and you don't even need to use one - see :h packages