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

docs: Update README.md and CREATE.md with more info for Lazy users #150

Merged
merged 3 commits into from
Jul 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CREATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,26 @@ require("lazy").setup({
{ dir = '/home/your_username_here/projects/cool_name', lazy = true },
}
```

Alternatively, if you organize your plugins by having a separate file for each
one in a dedicated plugins directory (e.g. ~/.config/nvim/lua/plugins),
you should instead call setup in init.lua as you would normally:

```lua
-- ~/.config/nvim/init.lua
require("lazy").setup("plugins")
```

And treat Lush and your colorscheme directory as you would any other plugin,
for example in lush.lua:

```lua
-- ~/.config/nvim/lua/plugins/lush.lua
return {
"rktjmp/lush.nvim",
{ dir = '/home/your_username_here/projects/cool_name', lazy = true },
}
```
Note that it may not show up in the menu if you enter, for example, `:colorscheme <tab>`. However, the following should work:

```vimscript
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ Install via any package management system, for example, paq:
require paq { 'rktjmp/lush.nvim' }
```

Via Lazy:

```lua
return {
"rktjmp/lush.nvim",
-- if you wish to use your own colorscheme:
-- { dir = '/absolute/path/to/colorscheme', lazy = true },
}
```

Interactive Tutorial
---------------------

Expand Down
Loading