Skip to content

docs: fix binary invocation flag syntax in quickstart - #2694

Merged
Prachi1615 merged 1 commit into
OpenMind:mainfrom
UmeshCode1:fix/quickstart-config-flag-syntax
Sep 28, 2026
Merged

Prachi1615 merged 1 commit into
OpenMind:mainfrom
UmeshCode1:fix/quickstart-config-flag-syntax

Conversation

@UmeshCode1

Copy link
Copy Markdown
Contributor

Overview

Fixes the quickstart command for running the pre-built om1 binary in README.md. The previous snippet './om1 config = ' caused a runtime error ('error: --config is required') because Go's flag parser in cmd/main.go expects '-config '.

Type of change

  • Bug fix
  • Documentation improvement

Changes

  • Updated line 79 in README.md from './om1 config = ' to './om1 -config '.
  • Aligns the pre-built binary launch instruction with cmd/main.go flag definition and subsequent launch examples.

Checklist

  • Code complies with style guidelines
  • Self-review completed
  • Documentation updated
  • Local testing completed

Impact

Prevents new users downloading pre-built binaries from encountering a CLI argument parse error upon first run.

@UmeshCode1
UmeshCode1 requested review from a team as code owners September 27, 2026 21:51
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🤖 This pull request passed PR Triage's initial automated check at commit 6620e08 — no issues found. It's marked for human review.

@Prachi1615 Prachi1615 closed this Sep 28, 2026
@Prachi1615 Prachi1615 reopened this Sep 28, 2026
@codecov

codecov Bot commented Sep 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Prachi1615
Prachi1615 merged commit 544d517 into OpenMind:main Sep 28, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants