Skip to content

docs: use Windows-safe setup commands in README#89

Open
calebwilson706 wants to merge 1 commit into
mainfrom
docs/windows-friendly-setup
Open

docs: use Windows-safe setup commands in README#89
calebwilson706 wants to merge 1 commit into
mainfrom
docs/windows-friendly-setup

Conversation

@calebwilson706

Copy link
Copy Markdown
Contributor

Why

Some Windows attendees hit errors running the getting-started commands:

  • npm install --prefix is broken on Windows - npm looks for package.json in the current directory instead of the prefix directory (npm/cli#7722, closed as not planned, with variants going back years). Behaviour varies by npm version, so it works for some attendees and fails for others.
  • The SSH clone URL fails for anyone without SSH keys configured on GitHub.

What

  • Replace npm install --prefix exercises/sample-app with a plain cd into the sample app followed by npm install. Separate lines rather than && chaining, because && isn't supported in Windows PowerShell 5.1.
  • Switch the clone command to HTTPS.

🤖 Generated with Claude Code

npm install --prefix is broken on Windows (npm/cli#7722, closed as not
planned) - replace it with a plain cd + npm install that works line by
line in PowerShell 5.1, cmd and bash. Also switch the clone command to
HTTPS so attendees without SSH keys can follow along.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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