Skip to content

docs(readme): add first-run provider setup guidance #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samhu1 merged 1 commit into from
Mar 24, 2026
Merged

docs(readme): add first-run provider setup guidance #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,21 @@ pnpm dist:linux

## Runtime Setup

### First Run Setup (packaged app users)

If you downloaded a release build (`.dmg`, `.exe`, `.AppImage`), complete this once before your first prompt:

1. Open **Settings** in OAgent.
2. Configure **one** provider: **OpenRouter** or **Ollama**.
3. Pick a model and save.

Downloading and launching the app is not enough by itself; at least one provider must be configured before prompts can run.

**OpenRouter vs Ollama (quick guide)**

- **OpenRouter**: cloud-hosted models, easiest setup with an API key, requires internet.
- **Ollama**: local models on your machine, more private/local-first, requires model download and local resources.

### OpenRouter

Set your OpenRouter key in app settings (`OpenRouter Key`) and choose a model.
Expand Down
Loading