Skip to content

Document the verified Windows PowerShell quickstart #6

Description

@five0nit

Problem

The README has a cross-platform development note, but first-time Windows contributors do not have one compact copy/paste example for running the installed CLI and the release validator in PowerShell.

Smallest useful outcome

Add a short PowerShell quickstart using the existing supported commands and path conventions.

Acceptance checks

  • uses .venv\\Scripts\\python.exe and .venv\\Scripts\\brief2ship.exe correctly;
  • includes install, doctor, --version, and scripts/validate-release.py;
  • does not claim WSL, Bubblewrap candidate execution, or optional Trafilatura works unless tested;
  • avoids administrator-only steps;
  • documentation links and release validation pass.

Good first contribution

This should be documentation-only unless the verified commands expose an actual defect.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or improvementgood first issueBounded contribution suitable for a first PRneeds-triageNeeds maintainer review

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions