Skip to content

Feature: Add Windows setup instructions for root quickstart and setup.sh #169

Description

@prajwal-priyadarshan

Problem statement

The repository’s quickstart and setup flow are Unix-centric. The root README uses Bash-based commands such as python3, source .venv/bin/activate, and ./setup.sh, so Windows users cannot follow the documented setup path without manual adaptation. That creates a barrier for contributors and first-time users on Windows.

Proposed solution

Add explicit Windows setup support in the root README and a Windows-friendly setup path. The cleanest fix is to document PowerShell steps for creating the virtual environment, installing dependencies, and setting environment variables, and to either add a setup.ps1 helper or make the existing setup instructions clearly cross-platform. The docs should also call out any Bash-only parts of setup.sh so Windows users know what to use instead.

Scope and impact

No response

Alternatives considered (optional)

No response

Additional context (optional)

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions