From d0d01349fb2aeaade4a0a42752d0e17f97c16cb9 Mon Sep 17 00:00:00 2001 From: Martin Bielik Date: Tue, 14 Mar 2023 19:34:37 +0100 Subject: installation and dependencies docu update --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3bf0461..b95dffd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # vim-ai -Complete text and chat with GPT in vim using OpenAI. +Complete text and chat with GPT in Vim/Neovim using OpenAI. ## Features @@ -12,7 +12,7 @@ Complete text and chat with GPT in vim using OpenAI. ## Installation -The plugin is compatible with Vim 8+ (tested on Debian). Windows OS is not supported yet. +vim-ai requires Vim/Neovim compiled with python3 support and the [openai-python](https://github.com/openai/openai-python) library. ```sh # configure openai api key https://platform.openai.com/account/api-keys @@ -25,11 +25,10 @@ export OPENAI_API_KEY="YOUR_OPENAI_API_KEY" Add plugin to your `.vimrc` using `vim-plug`: ```vim +" ./install.sh script will automatically install openai-python Plug 'madox2/vim-ai', { 'do': './install.sh' } ``` -The plugin requires `python3` and `pip3` to install and run [openai-python](https://github.com/openai/openai-python) library. - ## Usage ### :AI @@ -55,6 +54,8 @@ The plugin requires `python3` and `pip3` to install and run [openai-python](http `(visual selection)? :AIChat {instruction}?` - start a new conversation given the selection, the instruction or both +Press `Ctrl-c` to cancel completion. + #### Custom conversation prompts You can edit and save the conversation to an `.aichat` file and restore it later. -- cgit v1.2.3