Update README.md
This commit is contained in:
parent
06309f23ef
commit
9bc6b4d25c
14
README.md
14
README.md
@ -2,7 +2,8 @@
|
|||||||
|
|
||||||
**avante.nvim** is a Neovim plugin designed to emulate the behavior of the [Cursor](https://www.cursor.com) AI IDE, providing users with AI-driven code suggestions and the ability to apply these recommendations directly to their source files with minimal effort.
|
**avante.nvim** is a Neovim plugin designed to emulate the behavior of the [Cursor](https://www.cursor.com) AI IDE, providing users with AI-driven code suggestions and the ability to apply these recommendations directly to their source files with minimal effort.
|
||||||
|
|
||||||
⚠️⚠️ **WARNING: This plugin is still in a very early stage of development, so please be aware that the current code is very messy and unstable, and problems are likely to occur.**
|
> [!NOTE]
|
||||||
|
> ⚠️⚠️ This plugin is still in a very early stage of development, so please be aware that the current code is very messy and unstable, and problems are likely to occur.
|
||||||
|
|
||||||
https://github.com/user-attachments/assets/510e6270-b6cf-459d-9a2f-15b397d1fe53
|
https://github.com/user-attachments/assets/510e6270-b6cf-459d-9a2f-15b397d1fe53
|
||||||
|
|
||||||
@ -13,7 +14,14 @@ https://github.com/user-attachments/assets/510e6270-b6cf-459d-9a2f-15b397d1fe53
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
|
1. Install `tiktoken_core` (Optional):
|
||||||
|
|
||||||
|
- tiktoken_core: `sudo luarocks install --lua-version 5.1 tiktoken_core`. Alternatively, download a pre-built binary from [lua-tiktoken releases](https://github.com/gptlang/lua-tiktoken/releases)
|
||||||
|
- You can check your Lua PATH in Neovim by doing `:lua print(package.cpath)`. Save the binary as `tiktoken_core.so` in any of the given paths.
|
||||||
|
|
||||||
|
> For Arch Linux user, you can install [`luajit-tiktoken-bin`](https://aur.archlinux.org/packages/luajit-tiktoken-bin) or [`lua51-tiktoken-bin`](https://aur.archlinux.org/packages/lua51-tiktoken-bin) from aur!
|
||||||
|
|
||||||
|
2. Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
{
|
{
|
||||||
@ -36,7 +44,7 @@ Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Default setup configuration:
|
3. Default setup configuration:
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
{
|
{
|
||||||
|
Loading…
x
Reference in New Issue
Block a user