ahmedkhalf / project.nvim

The superior project management solution for neovim.
Apache License 2.0
1.29k stars 119 forks source link

Improve documentation #133

Open eyalk11 opened 10 months ago

eyalk11 commented 10 months ago

Hi, The current documentation is lacking.

AddProject is not even mentioned. I didn't understand why upon Telescope projects and enter it request me to find files. What files are assigned to what project? is it open buffers? is the lsp workspace variable kept?

andyl commented 9 months ago

Bingo

yrahul3910 commented 1 month ago

Yes, this took me quite a while to figure out. Contrary to what the README suggests, simply calling .setup() doesn't seem to suffice; you also need to call .init() afterwards:

require("project_nvim").setup()  -- you can add options here, I use defaults for now
require("project_nvim.project").init()

With this, Telescope picks up my projects for me in the search.