Added install instructions, and version check
This commit is contained in:
39
README.md
39
README.md
@@ -71,12 +71,43 @@ Automated email responses powered by AI:
|
||||
|
||||
## Installation
|
||||
|
||||
Not available.
|
||||
### Download
|
||||
|
||||
Download the latest release from the [Releases page](https://gitlab.pm/rune/oai-swift/releases). Two builds are available:
|
||||
|
||||
- **oAI-x.x.x-AppleSilicon.dmg** — for Macs with an Apple Silicon chip (M1 and later)
|
||||
- **oAI-x.x.x-Universal.dmg** — runs natively on both Apple Silicon and Intel Macs
|
||||
|
||||
### Installing from DMG
|
||||
|
||||
1. Open the downloaded `.dmg` file
|
||||
2. Drag **oAI.app** into the **Applications** folder
|
||||
3. Eject the DMG
|
||||
4. Launch oAI from Applications or Spotlight
|
||||
|
||||
### First Launch — Gatekeeper Warning
|
||||
|
||||
oAI is **signed by the developer** but has **not yet been notarized by Apple**. Notarization is Apple's automated malware scan — the app itself is safe, but macOS Gatekeeper may block it on first launch with a message saying the app "cannot be opened because the developer cannot be verified."
|
||||
|
||||
To open the app, you have two options:
|
||||
|
||||
**Option A — Right-click to open (quickest):**
|
||||
1. Right-click (or Control-click) `oAI.app` in Applications
|
||||
2. Select **Open** from the context menu
|
||||
3. Click **Open** in the dialog that appears
|
||||
4. After doing this once, the app opens normally from then on
|
||||
|
||||
**Option B — Remove the quarantine flag via Terminal:**
|
||||
|
||||
```bash
|
||||
xattr -dr com.apple.quarantine /Applications/oAI.app
|
||||
```
|
||||
|
||||
This command removes the quarantine attribute that macOS attaches to files downloaded from the internet. The `-d` flag deletes the attribute, `-r` applies it recursively to the app bundle. Once removed, macOS no longer blocks the app from launching.
|
||||
|
||||
### Requirements
|
||||
- macOS 14.0+
|
||||
- Xcode 15.0+
|
||||
- Swift 5.9+
|
||||
- macOS 14.0 (Sonoma) or later
|
||||
- An API key for at least one supported provider (OpenRouter, Anthropic, OpenAI, or Google), or Ollama running locally
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
Reference in New Issue
Block a user