PikaCourse / homiehomie

3 stars 0 forks source link

[Idea] Additional Instruction to Run the Repo for Windows10 Users #168

Open du201 opened 3 years ago

du201 commented 3 years ago

Idea: Additional Instruction to Run the Repo for Windows10 Users

What is this idea related to?

How to run this repo in windows10 environment

Is your feature request related to a problem? Please describe.

The current README instruction only works for Linux/Mac users

Describe the solution you'd like

It is recommended that Windows10 users download Windows Subsystem for Linux 2 (WSL2) which "lets developers run a GNU/Linux environment -- including most command-line tools, utilities, and applications -- directly on Windows, unmodified, without the overhead of a traditional virtual machine or dual-boot setup." The installation instruction can be found at https://docs.microsoft.com/en-us/windows/wsl/install-win10 After downloading WSL2, please remember to also download all the required libraries (npm, nodejs, pip, ...). In order to download "courseocean_webapi" when running the command "pip install -r requirements/dev.txt", make sure to create a ssh key pair and add the public key to your github account. ssh key instruction can be found at https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh