diff --git a/README.md b/README.md new file mode 100644 index 0000000..64fa3c6 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# ChatGPT NeoVim Plugin + +This Plugin should help the user to integrate ChatGPT o1 model into the development workflow with neovim. +It Provides two commands + +## :ChatGPT +This command will ask the user for a prompt. +It will then gather the following context: +- The project structure based on the git which the currently open file belongs to. +- The README.md file content if it exists in the top folder of the project structure. +- The currently open file content. + +It also appends to the prompt that every file should be in a code block and the first line of the block +should always just contain the file path for the file and nothing else. Regardless if it would destroy the code. + +The generated prompt for the ChatGPT o1 model, will than be copied to the clipboard and the user will be asked +to paste it into the website of ChatGPT. + +## :ChatGPTPaste +This command will look if the clipboard contains a response where the first line is a filepath. +It then creates the file and pastes the rest of the response as content into the file.