Skip to content

Add a 'Getting started in 5 minutes' quickstart #3

@ahmed-sekka

Description

@ahmed-sekka

The README is comprehensive but dense. A short quickstart would lower the barrier for newcomers evaluating the project.

Acceptance criteria

  • docs/quickstart.md (or top-of-README section) showing the smallest possible useful program
  • One Agent, one AgentGraph, runnable with mvn exec:java
  • No more than ~50 lines of Java
  • Linked from the README near the top

Suggested structure

  1. Add the dependency (1 snippet)
  2. Define an Agent (5 lines)
  3. Wire an AgentGraph (3 lines)
  4. Run it (1 command, expected output shown)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions