[DOCS]: "Getting started" in README only works in bash; fails on Windows PowerShell/CMD
Los mantenedores suelen responder en 1 día
@tarunagnihotri534 ya está trabajando en esto.
Desde el 18/11/2026.
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
- Área
- documentation
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
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
- Open PowerShell on a Windows 11 machine without Git Bash on PATH.
- Follow README "Getting started" step 2 exactly as written.
- 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.exeandopenssl.exeinC:\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
- PowerShell:
- Offer a PowerShell alternative for
sha256sum -c(for exampleGet-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
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de AOSSIE-Org/OpenVerifiableLLM
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
AOSSIE-Org/OpenVerifiableLLM#357 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
[BUG]: Forked runs omit timestamps for inherited chain entriesPosiblemente ocupada @pavithra-r06 la tomó hace 3 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
AOSSIE-Org/OpenVerifiableLLM#334 · 3 comentarios · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
[BUG]: review_ckpt.py passes a run that has .pt files no chain entry coversPosiblemente ocupada @arshil42 la tomó hace 3 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
AOSSIE-Org/OpenVerifiableLLM#332 · 4 comentarios · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
[BUG]: DigiCert timestamp verification fails on Windows because system_ca() ignores Windows CA bundlesPosiblemente ocupada @pavithra-r06 la tomó hace 3 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
AOSSIE-Org/OpenVerifiableLLM#290 · 2 comentarios · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
[BUG]: simple/ovl.py bench crashes with TypeError or ZeroDivisionError when stream yields <= 50 updatesPosiblemente ocupada @AdityasagarR123 la tomó hace 26 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
AOSSIE-Org/OpenVerifiableLLM#223 · 2 comentarios · 2 asignados ·
Los mantenedores suelen responder en 1 día
Todos los issues de AOSSIE-Org/OpenVerifiableLLM
Issues similares
-
LLMContextNode tool builders fail on nested params like `params:retrieval.max_matches`Posiblemente ocupada @Shizoqua la tomó hoy. AbiertoCommunity
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 2 días
-
security
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
btclib-org/portanode#985 ·
Los mantenedores suelen responder en 1 día
-
[Bug]: maps skill OSRM foot/cycling returns car times (router.project-osrm.org ignores profile)Abiertocomp/tools P2 tool/skills type/bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
NousResearch/hermes-agent#158494 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día
-
needs-format
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Niko1221/Strata#6475 · 1 comentario ·
Los mantenedores suelen responder en 6 días