summaryrefslogtreecommitdiffhomepage
path: root/packages
diff options
context:
space:
mode:
authorJay V <[email protected]>2025-07-24 18:57:50 -0400
committerJay V <[email protected]>2025-07-24 18:57:54 -0400
commit0c7e529e6d58ace514bd1d33febe52c0a48349a5 (patch)
treeba26ed019d4bd88f0f8960e2b3f59e0c80085da0 /packages
parent01f75839a900dd3abb5f0a493247a71712e096b9 (diff)
downloadopencode-0c7e529e6d58ace514bd1d33febe52c0a48349a5.tar.gz
opencode-0c7e529e6d58ace514bd1d33febe52c0a48349a5.zip
docs: add to quick start
Diffstat (limited to 'packages')
-rw-r--r--packages/web/src/content/docs/docs/index.mdx27
1 files changed, 24 insertions, 3 deletions
diff --git a/packages/web/src/content/docs/docs/index.mdx b/packages/web/src/content/docs/docs/index.mdx
index b96f773b1..871b5ca37 100644
--- a/packages/web/src/content/docs/docs/index.mdx
+++ b/packages/web/src/content/docs/docs/index.mdx
@@ -9,7 +9,21 @@ import { Tabs, TabItem } from "@astrojs/starlight/components"
![opencode TUI with the opencode theme](../../../assets/lander/screenshot.png)
-Let's start by installing opencode.
+Let's get started.
+
+---
+
+#### Prerequisites
+
+To use opencode, you'll need:
+
+1. A modern terminal emulator like:
+ - [WezTerm](https://wezterm.org), cross-platform
+ - [Alacritty](https://alacritty.org), cross-platform
+ - [Ghostty](https://ghostty.org), Linux and macOS
+ - [Kitty](https://sw.kovidgoyal.net/kitty/), Linux and macOS
+
+2. API keys for the LLM providers you want to use.
---
@@ -190,10 +204,17 @@ You can ask opencode to add new features to your project. Though we first recomm
Once it gives you a plan, you can give it feedback or add more details.
```txt frame="none"
- We'd like to design this new screen using the design we are already using.
- There's an example of a list of notes in @packages/web/src/components/NoteList.tsx
+ We'd like to design this new screen using a design I've used before.
+ [Image #1] Take a look at this image and use it as a reference.
```
+ :::tip
+ Drag and drop images into the terminal to add them to the prompt.
+ :::
+
+ opencode can scan any images you give it and add them to the prompt. You can
+ do this by dragging and dropping an image into the terminal.
+
3. **Build the feature**
Once you feel comfortable with the plan, switch back to _Build mode_ by