Skip to content

add guide for lazy.nvim #2041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

add guide for lazy.nvim #2041

wants to merge 1 commit into from

Conversation

rwxsb
Copy link

@rwxsb rwxsb commented Mar 7, 2023

Added on README.md quickstart section for Lazy.nvim package manager

@gegoune
Copy link
Collaborator

gegoune commented Mar 7, 2023

Thank you. I, personally am against adding installation details to readme. They are always towards the top and require scrolling over to get to more important information. Instruction on how to use plugin managers should (and do) fall on plugin managers themselves. Instead of adding another 15 lines I would rather see current installation method replaced with simple wording like: install with your preferred plugin manager or however else you manage your plugins.

No offence, just my opinion. Will leave it to @alex-courtis to decide.

@rwxsb
Copy link
Author

rwxsb commented Mar 9, 2023

Sure, understandable. We may move it to docs section as well. My motivation behind the PR is that I recently struggled adding this plugin to my nvim setup with lazy PM, thought it may help new comers to nvim.

Additionally, waiting response from @alex-courtis

@alex-courtis
Copy link
Member

Lazy loading, especially lazy.vim seems to be quite popular. See recent discussion #2052

I am, however, struggling to understand the use case. I've not received any good answers beyond "the cool factor". The use case is definitely there. @sbecerek I would be grateful for some insight here, so that nvim-tree can better work with it.

One motivation I can guess is startup time: we don't want plugin setup calls to be executed synchronously in init.lua. That isn't a problem for nvim-tree setup as it doesn't do anything beyond validating config. Nothing happens until you open the tree.

I've clarified the help around the nature of setup: https://github.com/nvim-tree/nvim-tree.lua/blob/master/doc/nvim-tree-lua.txt#L170

@alex-courtis
Copy link
Member

They are always towards the top and require scrolling over to get to more important information. Instruction on how to use plugin managers should (and do) fall on plugin managers themselves

Yes! This is the case for many plugins listing dozens of package manager setups and makes it very difficult to read the readme.

We can't put it in the help... chicken vs egg.

Proposal: create a wiki page for all the different package manager flavours. Users can add to that.

Install

Install "nvim-tree/nvim-tree.lua" and "nvim-tree/nvim-web-devicons" (optional) plugins.

See wiki: TODO plugin manager things for instructions for specific package managers.

@alex-courtis
Copy link
Member

@alex-courtis
Copy link
Member

Hopefully other plugins will follow our example ;)

You have inspired me to move build from source instructions to a separate page, for another of my projects.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants