Repository navigation
docs: clarify Unix build requirements and Windows support - #23
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Local setup instructions did not identify the supported host environment, so Windows users could reach dataset commands that depend on Unix-only Python file locking.
Add a requirements section before the README setup commands covering Linux/macOS, shell expectations, Node.js, pnpm, Python, network access, and dataset/build storage. State that native Windows build support is in development, and align the contributor and rendering guides with that requirement. Clarify that the hosted website remains accessible from Windows browsers.
Validation: reviewed the requirements against package.json, CI, and the dataset downloader; checked documentation links and git diff --check. Full
pnpm verifypassed (exit 0), including type checking, lint, unit/Python tests, browser acceptance, UI checks, and the production build. Browser dependencies were installed temporarily for the check.