Skip to content
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

Improve documentation #133

Open
eyalk11 opened this issue Sep 1, 2023 · 2 comments
Open

Improve documentation #133

eyalk11 opened this issue Sep 1, 2023 · 2 comments

Comments

@eyalk11
Copy link

eyalk11 commented Sep 1, 2023

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
Copy link

andyl commented Oct 3, 2023

Bingo

@yrahul3910
Copy link

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.

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

No branches or pull requests

3 participants