fix(install): prebuilt instruction (closes #474) (#476)

Signed-off-by: Aaron Pham <contact@aarnphm.xyz>
This commit is contained in:
Aaron Pham
2024-09-03 06:53:14 -04:00
committed by GitHub
parent a5726bd2bf
commit 24b66e08dc
4 changed files with 31 additions and 13 deletions

View File

@@ -19,6 +19,9 @@ https://github.com/user-attachments/assets/86140bfd-08b4-483d-a887-1b701d9e37dd
## Installation
For building binary if you wish to build from source, then `cargo` is required. Otherwise `curl` and `jq` will be used to get prebuilt binary from GitHub.
For prebuilt binary, one must set the following `GITHUB_TOKEN` in given shell (instruction for creating PAT is [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens))
<details open>
@@ -32,10 +35,9 @@ https://github.com/user-attachments/assets/86140bfd-08b4-483d-a887-1b701d9e37dd
opts = {
-- add any opts here
},
-- if you want to build from source, then pass source=true (requires cargo).
-- Also note that building from source will block startuptime since
-- we are compiling bindings in Rust.
build = ":AvanteBuild",
-- if you want to download pre-built binary, then pass source=false. Make sure to follow instruction above.
-- Also note that downloading prebuilt binary is a lot faster comparing to compiling from source.
build = ":AvanteBuild source=false",
dependencies = {
"stevearc/dressing.nvim",
"nvim-lua/plenary.nvim",
@@ -117,7 +119,7 @@ add({
'MunifTanjim/nui.nvim',
'echasnovski/mini.icons'
},
hooks = { post_checkout = function() vim.cmd('AvanteBuild') end }
hooks = { post_checkout = function() vim.cmd('AvanteBuild source=false') end }
})
--- optional
add({ source = 'zbirenbaum/copilot.lua' })