Adding installation guide for Windows Users
Increasing Access
The guide will improve the access for people using Windows, and people with minimum/basic technological skill.
Feature enhancement details
A section titled "Installation guide for Windows users" will be added below the overall manual installation guide section.
Issue: Currently the overall manual installation assumes users are using unix-like shell, and recommends using nvm as the first step. However, there is a technical hurdle for Windows users to adopt nvm (need to install WSL or find an equivalent, windows nvm, which is not mentioned in the guide). The easiest option is to skip reading the description on nvm and manually install node.js. But a user with minimum technical knowledge may not be able to skip read.
https://github.com/processing/p5.js-web-editor/blob/develop/contributor_docs/installation.md#manual-installation
Solution: The added section will provide installation steps similar to the one provided in the manual installation section, only tuned towards Windows users to reduce confusion in the process.
Welcome! 👋 Thanks for opening your first issue here! And to ensure the community is able to respond to your issue, be sure to follow the issue template if you haven't already.
Hi! @imrinahru 👋
I would like to work on this issue.
I can add the Windows-specific installation guide to the documentation as described.
Please let me know if I should proceed or if there are any additional details to include.
Hello @amritamishra01 ! Thank you for taking interest in this! I was planning to add some documentation on my end, but if you already have an idea of what you want to include, please go ahead! I'm very new to open-source contribution, so on the one hand the installation process is still fresh in my memory, but on the other hand, I only did the manual installation of node.js through installer, without using nvm. so now I have a setup that's quite difficult to switch between different versions of node. If you could include how to add version control on windows, that would be great!
I'd suggest waiting for maintainer approval to proceed.
cc @raclim
Hi @imrinahru I'm sorry that it took a while to get to this issue!
Hmm, maybe both @amritamishra01 @imrinahru would you like to work on this issue together? I'm imagining that one of you could go ahead with creating the PR and the other could review and comment on the PR thread if that sounds good!
@raclim Hi! I’m interested in improving the installation docs for Windows users. The current manual installation assumes a Unix-like shell and recommends nvm, which can confuse Windows beginners. I’d like to add a short “Installation Guide for Windows Users” section right below the manual installation guide, with simple steps tailored for Windows (e.g., direct Node.js installation instead of nvm)
@raclim No worries, it's good that many people are interested in this thread and there's need for this! @amritamishra01 @SinhaS12 if possible, would you be interested in reviewing my pull request? I have started this thread with a consultation with @raclim to also familiarize myself with pull request.
Sorry for the confusion since until now no one is assigned yet. @raclim Would you be able to assign it to me so that people can know it's in progress? I don't have the authority/button to assign people
Yes I can go ahead with assigning @imrinahru! Once your PR is in, please feel free to go ahead with tagging all of the folks within this thread, or anyone else you'd like to include to take a look!
Thanks @raclim! Sure, once the PR is up, I’ll be happy to take a look and provide a review. Looking forward to seeing the changes @imrinahru!