[DOCS]: "Getting started" in README only works in bash; fails on Windows PowerShell/CMD
I maintainer di solito rispondono entro 1 giorno
@tarunagnihotri534 ci sta già lavorando.
Dal 18/11/2026.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Ferma
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Python
- Stelle
- 26
- Fork
- 64
- Merge medio
- 2g 11h
- PR unite (30g)
- 71
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di AOSSIE-Org/OpenVerifiableLLM
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
AOSSIE-Org/OpenVerifiableLLM#357 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
[BUG]: Forked runs omit timestamps for inherited chain entriesForse già presa @pavithra-r06 l’ha presa 3 giorni fa. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
AOSSIE-Org/OpenVerifiableLLM#334 · 3 commenti · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
-
[BUG]: review_ckpt.py passes a run that has .pt files no chain entry coversForse già presa @arshil42 l’ha presa 3 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
AOSSIE-Org/OpenVerifiableLLM#332 · 4 commenti · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
-
[BUG]: DigiCert timestamp verification fails on Windows because system_ca() ignores Windows CA bundlesForse già presa @pavithra-r06 l’ha presa 18 giorni fa. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
AOSSIE-Org/OpenVerifiableLLM#290 · 2 commenti · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
-
[BUG]: simple/ovl.py bench crashes with TypeError or ZeroDivisionError when stream yields <= 50 updatesForse già presa @AdityasagarR123 l’ha presa 26 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
AOSSIE-Org/OpenVerifiableLLM#223 · 2 commenti · 2 assegnatari ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di AOSSIE-Org/OpenVerifiableLLM
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 73/100
I maintainer di solito rispondono entro 1 giorno
-
Unused loot bag group names left in dreamcraft en_US.langForse già presa Una pull request collegata a questa issue è aperta o già unita. ApertaStatus: Triage Suggestion
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
GTNewHorizons/GT-New-Horizons-Modpack#27789 ·
I maintainer di solito rispondono entro 1 giorno
-
bug frontend sev-5
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
-
core good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
b4b code health next
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
ESCOMP/CTSM#4330 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno