Add Plug
install info to README.md (#364)
* README.md: add Plug install info * README.md: polish
This commit is contained in:
parent
fa043bf8ce
commit
063a5ed24b
39
README.md
39
README.md
@ -17,6 +17,8 @@ https://github.com/user-attachments/assets/86140bfd-08b4-483d-a887-1b701d9e37dd
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
### Lazy
|
||||||
|
|
||||||
Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
|
Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
@ -67,6 +69,39 @@ Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### or with Plug
|
||||||
|
|
||||||
|
```vim
|
||||||
|
|
||||||
|
" Deps
|
||||||
|
Plug 'stevearc/dressing.nvim'
|
||||||
|
Plug 'nvim-lua/plenary.nvim'
|
||||||
|
Plug 'MunifTanjim/nui.nvim'
|
||||||
|
|
||||||
|
" Optional deps
|
||||||
|
Plug 'nvim-tree/nvim-web-devicons' "or Plug 'echasnovski/mini.icons'
|
||||||
|
Plug 'HakonHarnes/img-clip.nvim'
|
||||||
|
|
||||||
|
" Yay
|
||||||
|
Plug 'yetone/avante.nvim'
|
||||||
|
```
|
||||||
|
|
||||||
|
and Lua:
|
||||||
|
|
||||||
|
```lua
|
||||||
|
-- deps:
|
||||||
|
require('img-clip').setup ({
|
||||||
|
-- use recommended settings from above
|
||||||
|
})
|
||||||
|
require('render-markdown').setup ({
|
||||||
|
-- use recommended settings from above
|
||||||
|
})
|
||||||
|
require('avante').setup ({
|
||||||
|
-- Your config here!
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### Install Notes
|
||||||
|
|
||||||
> [!IMPORTANT]
|
> [!IMPORTANT]
|
||||||
>
|
>
|
||||||
@ -75,7 +110,7 @@ Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
|
|||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
>
|
>
|
||||||
> `render-markdown.nvim` is an optional dependency that is used to render the markdown content of the chat history. Make sure to also include `Avante` as a filetype
|
> `render-markdown.nvim` is an optional dependency that is used to render the markdown content of the chat history. Make sure to also include `Avante` as a filetype
|
||||||
> to its setup:
|
> to its setup (e.g. via Lazy):
|
||||||
>
|
>
|
||||||
> ```lua
|
> ```lua
|
||||||
> {
|
> {
|
||||||
@ -87,7 +122,7 @@ Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
|
|||||||
> }
|
> }
|
||||||
> ```
|
> ```
|
||||||
|
|
||||||
Default setup configuration:
|
### Default setup configuration
|
||||||
|
|
||||||
_See [config.lua#L9](./lua/avante/config.lua) for the full config_
|
_See [config.lua#L9](./lua/avante/config.lua) for the full config_
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user