[DOCS]: "Getting started" in README only works in bash; fails on Windows PowerShell/CMD

Abierto
#353 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@tarunagnihotri534 ya está trabajando en esto.

Desde el 18/11/2026.

  • #354 de @tarunagnihotri534 — abierto
  • #358 de @deba2k5 — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
bash, git, powershell, python, shell

Línea de trabajo

Update the README “Getting started” step 2 and docs/verify.md, keeping their Windows commands consistent. Start by comparing the existing consistency-check and hf download instructions in both files; document Windows prerequisites and shell-specific command forms, with done defined as a new Windows user being able to follow the README through the consistency check. A linked open pull request (#354) indicates this work is already underway.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

good first issue
Context

Summary

The "Getting started" section of the README (step 2, consistency check) assumes a bash shell. On Windows PowerShell or CMD, several commands fail, and the README doesn't say what Windows users need. The README already has a note for macOS (brew install coreutils for sha256sum), but nothing for Windows.

Environment

  • OS: Windows 11 Pro (build 26100)
  • Shell: PowerShell
  • Python: 3.13.0
  • Commit: 1c63518 (main, post-v1.1.0)
  • Hardware: CPU only

What fails

README command Problem on Windows
sha256sum -c --ignore-missing release-hashes.txt sha256sum is not installed by default
OVL_DEVICE=cpu python ovl-code/simple/ovl.py verify ... Inline VAR=value command is bash-only syntax
hf download ... \ (multi-line) \ line continuation doesn't work in PowerShell (needs a backtick) or CMD (needs ^)
openssl (used by the timestamp check) Not installed by default; not mentioned as a Windows prerequisite

Steps to reproduce

  1. Open PowerShell on a Windows 11 machine without Git Bash on PATH.
  2. Follow README "Getting started" step 2 exactly as written.
  3. Run:
   sha256sum -c --ignore-missing release-hashes.txt
   OVL_DEVICE=cpu python ovl-code/simple/ovl.py verify --run . --weights conversation-model.pt

Expected behavior

The README (or docs/verify.md) either gives Windows equivalents or lists Windows prerequisites, so a new user can complete the consistency check.

Actual behavior

What Needs to Be Done

Update the README "Getting started" section (step 2, consistency check) and docs/verify.md so Windows users can complete the steps without bash.

Tasks

  • Add a short "Windows" note to README step 2 listing prerequisites: Git for Windows provides sha256sum.exe and openssl.exe in C:\Program Files\Git\usr\bin. Tell users to add that folder to PATH, or run the steps in Git Bash.
  • Show the environment variable per shell next to the existing bash command:
    • PowerShell: $env:OVL_DEVICE="cpu"; python ovl-code/simple/ovl.py verify --run . --weights conversation-model.pt
    • CMD: set OVL_DEVICE=cpu && python ovl-code/simple/ovl.py verify --run . --weights conversation-model.pt
  • Offer a PowerShell alternative for sha256sum -c (for example Get-FileHash), or mention that Git Bash handles it.
  • Rewrite the multi-line hf download ... \ command so it works on Windows: put it on one line, or show the PowerShell (`) and CMD (^) line continuations.
  • Add the same Windows notes to docs/verify.md so the two pages stay consistent.
  • Test every updated command on a clean Windows 11 machine (PowerShell and CMD) and confirm the expected output matches the README.

Acceptance criteria

  • A new user on Windows can finish the consistency check by following the README alone.
  • The bash instructions for Linux and macOS stay unchanged.
  • The README and docs/verify.md give the same commands.

Scope: documentation only, with no code changes.

Resources
Getting Started
  • I have joined the Discord server and will post updates there
  • I have read the Contribution Guide
  • I understand this issue is assigned on a first-come, first-served basis
Lenguaje dominante
Python
Estrellas
26
Forks
64
Merge medio
2 d 11 h
PR fusionados (30 d)
71

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de AOSSIE-Org/OpenVerifiableLLM

Todos los issues de AOSSIE-Org/OpenVerifiableLLM

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.