Skip to content

Commit

Permalink
add get started simple page
Browse files Browse the repository at this point in the history
  • Loading branch information
rjmacarthy committed Apr 29, 2024
1 parent ffd6654 commit ad6cc77
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
15 changes: 12 additions & 3 deletions src/content/docs/guides/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,17 @@ title: Get started
description: A get started guide for twinny
---

TODO
### Using Ollama

## Further reading
1. Install the VS Code extension [here](https://marketplace.visualstudio.com/items?itemName=rjmacarthy.twinny) or [VSCodium here](https://open-vsx.org/extension/rjmacarthy/twinny).
2. Set up Ollama as the backend by default: [Install Ollama](https://ollama.com/)
3. Select your model from the [Ollama library](https://ollama.com/library) (e.g., `codellama:7b-instruct` for chats and `codellama:7b-code` for auto complete).

- TODO
```sh
ollama run codellama:7b-instruct
ollama run codellama:7b-code
```

4. Open VS code (if already open a restart might be needed) and press `ctr + shift + T` to open the side panel.

You should see the 🤖 icon indicating that twinny is ready to use.
2 changes: 0 additions & 2 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ hero:
title: |
twinny
tagline: No-nonsense Local or API-hosted AI code completion plugin for Visual Studio Code.
image:
file: ../../assets/twinny.svg
actions:
- text: Get started
link: /twinny-docs/guides/get-started
Expand Down

0 comments on commit ad6cc77

Please sign in to comment.