Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
lgrammel committed Oct 4, 2023
1 parent 697553f commit e7e63f3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 5 additions & 3 deletions app/vscode/asset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@

> #### AI chat in the Visual Studio Code side bar. Rubberduck can [generate code](#generate-code), [edit code](#edit-code), [explain code](#explain-code), [generate tests](#generate-tests), [find bugs](#find-bugs), [diagnose errors](#diagnose-errors), and more. You can even add [your own conversation templates](https://github.com/rubberduck-ai/rubberduck-vscode/blob/main/doc/rubberduck-templates.md).
# Setup with OpenAI
# Setup

## OpenAI

1. Get an OpenAI API key from [platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys) (you'll need to sign up for an account)
2. Enter the API key with the `Rubberduck: Enter OpenAI API key` command

# Alternative: use local AI models with Llama.cpp (experimental)
## Llama.cpp (experimental)

You can use Rubberduck with local models, e.g. [CodeLlama-7B-Instruct](https://huggingface.co/TheBloke/CodeLlama-7B-Instruct-GGUF) running in [Llama.cpp](https://github.com/ggerganov/llama.cpp) (see [ModelFusion Llama.cpp setup](https://modelfusion.dev/integration/model-provider/llamacpp#setup)). To enable llama.cpp in Rubberduck, set the `Rubberduck: Model` setting to `llama.cpp`.

# Configuration Options
## Configuration Options

- **rubberduck.syntaxHighlighting.useVisualStudioCodeColors**: Use the Visual Studio Code Theme colors for syntax highlighting in the diff viewer. Might not work with all themes. Default is `false`.

Expand Down
2 changes: 1 addition & 1 deletion app/vscode/asset/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"publisher": "rubberduck",
"name": "rubberduck-vscode",
"version": "1.18.0",
"version": "1.18.1",
"displayName": "Rubberduck - ChatGPT for Visual Studio Code",
"description": "Generate code, edit code, explain code, generate tests, find bugs, diagnose errors, and even create your own conversation templates.",
"keywords": [
Expand Down

0 comments on commit e7e63f3

Please sign in to comment.