Skip to content

Commit f90910a

Browse files
respencer-nclclaude
andcommitted
Simplify quickstart validation instructions to use Homebrew
Replace build-from-source instructions with brew install and link to full installation guide for other platforms. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent b7279af commit f90910a

1 file changed

Lines changed: 12 additions & 8 deletions

File tree

docs/riddl/quickstart.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -269,19 +269,23 @@ domain OnlineShop is {
269269

270270
## Validate Your Model
271271

272-
Use the RIDDL compiler to check for errors:
272+
Use the RIDDL compiler to check your model for errors.
273+
274+
**Install riddlc (macOS):**
273275

274276
```bash
275-
# Install riddlc (requires JDK 25)
276-
git clone https://github.com/ossuminc/riddl.git
277-
cd riddl
278-
sbt riddlc/stage
277+
brew install ossuminc/tap/riddlc
278+
```
279+
280+
For other platforms, see the [installation guide](tools/riddlc/installation.md).
279281

280-
# Validate your model
281-
./riddlc/target/universal/stage/bin/riddlc validate shop.riddl
282+
**Validate your model:**
283+
284+
```bash
285+
riddlc validate shop.riddl
282286
```
283287

284-
Or use an IDE with RIDDL support:
288+
You can also get real-time validation in your editor with RIDDL IDE support:
285289

286290
- [VS Code Extension](../OSS/vscode-extension/index.md)
287291
- [IntelliJ Plugin](../OSS/intellij-plugin/index.md)

0 commit comments

Comments
 (0)