Update the clients/vim/README.md (#253)
Added a section that explains how to install the extension on packer and lazy.improve-workflow
parent
69084d4c1e
commit
41c747e295
|
|
@ -7,17 +7,39 @@
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
### Plug
|
### 🔌 Vim-Plug
|
||||||
```
|
```
|
||||||
" Make sure that the filetype plugin has been enabled.
|
" Make sure that the filetype plugin has been enabled.
|
||||||
filetype plugin on
|
filetype plugin on
|
||||||
|
|
||||||
" Assume using vim-plug as plugin manager
|
" Add this to the vim-plug config
|
||||||
Plug 'TabbyML/tabby', {'rtp': 'clients/vim'}
|
Plug 'TabbyML/tabby', {'rtp': 'clients/vim'}
|
||||||
|
|
||||||
" Set URL of Tabby server
|
" Set URL of Tabby server
|
||||||
let g:tabby_server_url = 'http://127.0.0.1:8080'
|
let g:tabby_server_url = 'http://127.0.0.1:8080'
|
||||||
```
|
```
|
||||||
|
### 📦 Packer and Lazy
|
||||||
|
In this case, you first need to clone the repo in your machine
|
||||||
|
```
|
||||||
|
git clone https://github.com/TabbyML/tabby.git ~/tabby
|
||||||
|
```
|
||||||
|
Then on the config file:
|
||||||
|
```
|
||||||
|
" For lazy
|
||||||
|
return { name = "tabby", dir = '~/tabby/clients/vim', enabled = true }
|
||||||
|
|
||||||
|
" For packer
|
||||||
|
use {'~/tabby/clients/vim', as = 'tabby', enabled = true}
|
||||||
|
|
||||||
|
" Set URL of Tabby server
|
||||||
|
|
||||||
|
" With Lua
|
||||||
|
vim.g.tabby_server_url = 'http://127.0.0.1:8080'
|
||||||
|
|
||||||
|
" With VimScript
|
||||||
|
let g:tabby_server_url = 'http://127.0.0.1:8080'
|
||||||
|
```
|
||||||
|
> In the future, the ideal would be to export the Vim extension to a separate Git repository. This would simplify the installation process [#252](https://github.com/TabbyML/tabby/issues/252).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue