From 41c747e29526561c3b07e1464c0b77e125d5c68f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pau=20Garc=C3=ADa=20Chiner?= <49660697+pauchiner@users.noreply.github.com> Date: Mon, 19 Jun 2023 22:50:48 +0200 Subject: [PATCH] Update the clients/vim/README.md (#253) Added a section that explains how to install the extension on packer and lazy. --- clients/vim/README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/clients/vim/README.md b/clients/vim/README.md index 24069d4..b3f1eb8 100644 --- a/clients/vim/README.md +++ b/clients/vim/README.md @@ -7,17 +7,39 @@ ## Getting started -### Plug +### 🔌 Vim-Plug ``` " Make sure that the filetype plugin has been enabled. filetype plugin on -" Assume using vim-plug as plugin manager +" Add this to the vim-plug config Plug 'TabbyML/tabby', {'rtp': 'clients/vim'} " Set URL of Tabby server 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