dashboard icon indicating copy to clipboard operation
dashboard copied to clipboard

Add Windows Setup Instructions to README

Open create2000 opened this issue 1 year ago • 1 comments

What would you like to be added?

The current README file does not include Windows-specific setup commands. This may create difficulties for users running Windows who want to set up the project locally.

Proposed Solution:

  • Add Windows command-line instructions for installing dependencies and running the project.
  • Include PowerShell commands as an alternative.
  • Ensure documentation consistency with the existing setup guide.

Why is this needed?

  • Improves the onboarding experience for Windows users.
  • Enhances cross-platform compatibility.
  • Keeps the documentation more inclusive and user-friendly.

create2000 avatar Feb 20 '25 11:02 create2000

Hi @create2000 % @DoisLONG,

I'd like to work on adding Windows setup instructions to the README!

My plan is to create a dedicated Windows section with both Command Prompt and PowerShell alternatives for all setup steps, including Node.js/Git installation via package managers and manual methods, plus a troubleshooting section for common Windows issues.

I'll test all commands on Windows to ensure they work correctly and maintain consistency with the existing documentation style. This will significantly improve the onboarding experience for Windows developers and enhance cross-platform accessibility. Could I be assigned to this issue?

Excited to help make the documentation more inclusive!

Can I be assigned this issue so that I can start working on this one

NishantSinghhhhh avatar Jul 16 '25 10:07 NishantSinghhhhh