Skip to content

[Docs] Create README for independent fork #23

@randomm

Description

@randomm

Problem

The current README is inherited from upstream OpenCode and doesn't reflect our independent fork's purpose, installation, or goals.

Requirements

Content to include:

  1. Project identity - Name (oclite?), purpose, relationship to upstream
  2. Attribution - Credit to upstream OpenCode (MIT license requirement)
  3. Goals/Philosophy - Opinionated, remory-integrated, agentic workflow focused
  4. Installation
    • Clone and build locally (bun run build)
    • Future: GitHub Releases with binaries
  5. Configuration - Key differences from upstream
  6. Distribution - GitHub-only for now (no npm, VS Code marketplace, etc.)
  7. Contributing - Our contribution guidelines (if accepting)
  8. License - MIT (same as upstream)

Attribution example:

Based on [OpenCode](https://github.com/anomalyco/opencode) by Anomaly Co (MIT License)

Out of Scope

  • Third-party publishing (npm, Homebrew, AUR)
  • VS Code extension docs
  • Desktop app docs

Acceptance Criteria

  • README reflects our fork's identity
  • Clear installation instructions
  • Upstream attribution included
  • Old upstream-specific content removed

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions