greatbody
/
freeCodeCamp
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(docs): update set up note for clarity (#50710)

pull/50716/head
ervinjohn50 2023-06-15 05:35:37 -07:00 committed by GitHub
parent 01ae9d3561
commit eeb23d6472
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/how-to-setup-freecodecamp-locally.md
View File

@ -2,6 +2,9 @@ Follow these guidelines for setting up a development environment for freeCodeCam
## Choose between Gitpod or your Own Machine (local setup)
> [!ATTENTION]
> **Note:** freeCodeCamp does NOT run natively on Windows 10 or 11, you will need to use WSL2. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
If you are looking to make a one-off contribution, you should use Gitpod to make changes. The Gitpod setup launches a ready-to-code environment in a few minutes in your web browser. For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
Here are some pros and cons which should help you decide which option is best for you:
@ -15,9 +18,6 @@ Here are some pros and cons which should help you decide which option is best fo
| Need an internet connection to work | Minimal internet connection required (once setup) |
| Some tasks like compilation and tests can take longer to complete | Faster completion of tasks (depending on your machine's capabilities) |
> [!ATTENTION]
> **Note:** If you are using Windows 10 or 11, you will need to use WSL2. You can follow [this guide](how-to-setup-wsl.md) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
### How to Prepare a Gitpod Workspace
We have automated the process of installing all the dependencies & tools you will need. With Gitpod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes.