Skip to content

Add comprehensive quickstart section to README #184

@kai-linux

Description

@kai-linux

Goal

Add a "Get Started in 5 Minutes" section to the README that allows new users to understand and run Agent OS without friction.

Success Criteria

  • README includes a step-by-step quickstart with copy-paste commands
  • New user can go from zero to first task execution in <5 minutes
  • Quickstart covers: installation, configuration, running first task, viewing results
  • Section is positioned prominently (top third of README)

Constraints

  • Must not exceed 200 lines of text
  • Should reference existing "Try It in 5 Minutes" sandbox content
  • Must work on macOS and Linux

Outcome Checks

agent_success_rate, escalation_rate, task_completion_time

Metadata

Metadata

Assignees

No one assigned

    Labels

    bot-generatedCreated by agent-os automation (groomer/planner/log-analyzer)doneenhancementNew feature or requestprio:high

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions