feature: More verbose initial installation steps

[ted-miller92]

Did you check the docs?

• I have read all the lazy.nvim docs

Is your feature request related to a problem? Please describe.

When I found lazy.nvim, I had a little trouble with the initial installation steps as this was my first time using any plugin manager for Neovim. It turns out it's really quite simple, but I had to do a little digging around on the internet to figure it out. Given that a plugin manager appeals to beginners, I wonder if some consideration could be given to this since a likely large portion of lazy.nvim's audience is beginner/novice.

Describe the solution you'd like

I have forked a new branch and edited the initial install instructions in the README to include a link to build instructions for Neovim, and a more verbose description and diagram of the initial file structure that a new user might not be familiar with.

Describe alternatives you've considered

I am open to other ideas but I also considered a sort of table of contents for the README file to clarify the sections.

Additional context

No response

[dpetka2001]

I'm just a regular user like you and everything that follows is my own personal opinion.

• Regarding your link about building Neovim, it shouldn't be the responsibility of a package manager to advise the user how to install Neovim. In fact there are other easier methods for installing Neovim instead of building it from source, especially if the context is to be made more appealing to beginners. (bob, scoop on Windows, the appimage from the Neovim repo etc)

• The directory structure you're mentioning is already being covered in structuring your plugins and it's meant to be taken as only a reference, since there can be other ways to how a user would organize their own files.

• Your mentioning about bootstrapping lazy.nvim and adding it below the code, to me it seems like just rewording without any substantial additional meaning (don't mean to be cruel, just criticizing what you wrote in my personal opinion).

• This is an example of what the above statement could look like at the end of the `init.lua` , when there's already a mention in the following example as a comment that it's an example, to me seems redundant additional wording.

• I kind of agree with your rewording about

  As your list of plugins grows, you can store them in individual files in the ~/.config/nvim/lua/plugins/ directory. Each file should return a lua table.

  Compared to the mention of Lua modules, which might be a bit confusing to beginners, but I don't suggest that the sentence about the Lua modules should be removed.

• Your mention of the Lazy command in Basic Usage is already mentioned in the Usage section.

Github already provides a table of contents according to the Markdown Headers of the README

[ted-miller92]

Hi,

Thank you for the feedback, those are all good points. I will make some edits to my proposed changes. Upon re-reading my suggestions, a couple parts are certainly repetitious/redundant.

[the-real-droop]

Couldn't agree more. For a completely clueless dunce like me who doesn't know where to look for my init.lua, the install instructions left a lot to be desired and made me look for other options.