Skip to content

docs: clarify Unix build requirements and Windows support - #23

Merged
omggga merged 1 commit into
mainfrom
docs/build-platform-requirements
Sep 9, 2026
Merged

omggga merged 1 commit into
mainfrom
docs/build-platform-requirements

Conversation

@omggga

@omggga omggga commented Sep 9, 2026

Copy link
Copy Markdown
Owner

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 verify passed (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.

@omggga
omggga merged commit e3eaf7d into main Sep 9, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant