From 7f0d980ce464edf0eb682d887107f0b14321ad94 Mon Sep 17 00:00:00 2001 From: Martin Bielik Date: Mon, 24 Apr 2023 17:44:45 +0200 Subject: wiki references --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e54e306..99254c0 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ You can generate code, edit text, or have an interactive conversation with GPT m ![vim-ai demo](./demo.gif) +To get an idea what is possible to do with AI commands see the [prompts](https://github.com/madox2/vim-ai/wiki/AI-prompts#prompts) on the [Community Wiki](https://github.com/madox2/vim-ai/wiki) + ## Features - Generate text or code, answer questions with AI @@ -77,6 +79,8 @@ To use an AI command, type the command followed by an instruction prompt. You ca **Tip:** setup your own [key bindings](#key-bindings) or use command shortcuts - `:AIE`, `:AIC`, `:AIR` +If you are interested in more tips or would like to level up your Vim with more commands like [`:GitCommitMessage`](https://github.com/madox2/vim-ai/wiki/Custom-commands#suggest-a-git-commit-message) - suggesting a git commit message, visit the [Community Wiki](https://github.com/madox2/vim-ai/wiki). + ## Reference In the documentation below, `` denotes a visual selection, `{instruction}` an instruction prompt and `?` symbol an optional parameter. @@ -262,10 +266,6 @@ let g:vim_ai_chat = { \ "scratch_buffer_keep_open": 0, \ }, \} - -" Tips: -" "open_chat_command": -" - "below new /tmp/last_conversation.aichat" - restore converstaion from a file ``` ### Using chat engine for completion and edits @@ -304,7 +304,9 @@ let g:vim_ai_edit = chat_engine_config ## Custom commands -To create a custom command, you can call `AIRun`, `AIEditRun` and `AIChatRun` functions. See examples below: +You might find useful a [collection](https://github.com/madox2/vim-ai/wiki/Custom-commands) of custom commands on the [Community Wiki](https://github.com/madox2/vim-ai/wiki). + +To create a custom command, you can call `AIRun`, `AIEditRun` and `AIChatRun` functions. For example: ```vim " custom command suggesting git commit message, takes no arguments @@ -337,6 +339,10 @@ endfunction command! -range CodeReview ,call CodeReviewFn() ``` +## Contributing + +Contributions are welcome! Please feel free to open a pull request, report an issue, or contribute to the [Community Wiki](https://github.com/madox2/vim-ai/wiki). + ## Important Disclaimer **Accuracy**: GPT is good at producing text and code that looks correct at first glance, but may be completely wrong. Be sure to thoroughly review, read and test all output generated by this plugin! -- cgit v1.2.3