Update README.md

This commit is contained in:
yetone 2024-08-15 14:38:11 +08:00 committed by GitHub
parent 06309f23ef
commit 9bc6b4d25c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -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.
⚠️⚠️ **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
@ -13,10 +14,17 @@ https://github.com/user-attachments/assets/510e6270-b6cf-459d-9a2f-15b397d1fe53
## Installation
Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
1. Install `tiktoken_core` (Optional):
```lua
{
- 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
{
"yetone/avante.nvim",
event = "VeryLazy",
config = function()
@ -33,13 +41,13 @@ Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
"nvim-lua/plenary.nvim",
"MeanderingProgrammer/render-markdown.nvim",
},
}
```
}
```
Default setup configuration:
3. Default setup configuration:
```lua
{
```lua
{
provider = "claude", -- "claude" or "openai" or "azure"
openai = {
endpoint = "https://api.openai.com",
@ -77,8 +85,8 @@ Default setup configuration:
prev = "[x",
},
},
}
```
}
```
## Usage