Skip to content

docs: clarify the README and getting started - #73

Draft
MrScripty wants to merge 1 commit into
mainfrom
docs/readme-clarity-20261015
Draft

MrScripty wants to merge 1 commit into
mainfrom
docs/readme-clarity-20261015

Conversation

@MrScripty

Copy link
Copy Markdown
Owner

Summary

  • Lead with sharing one local model library across applications.
  • Put supported desktop and headless source routes first, including their native build prerequisites.
  • Link maintained API and operational guidance while preserving ownership, runtime and platform limits.
  • Retain the existing branding banner; this change does not add a UI screenshot.

Verification

  • Revalidated current main and checked command entry points and relative links against source.
  • Independently reviewed the final README and visually inspected the retained banner.
  • Runtime commands were not executed for this documentation-only edit.

@coderabbitai

coderabbitai Bot commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant