From eeb23d64724a94ecec0f273a58384ae78910a504 Mon Sep 17 00:00:00 2001 From: ervinjohn50 <71913788+ervinjohn50@users.noreply.github.com> Date: Thu, 15 Jun 2023 05:35:37 -0700 Subject: [PATCH] fix(docs): update set up note for clarity (#50710) --- docs/how-to-setup-freecodecamp-locally.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/how-to-setup-freecodecamp-locally.md b/docs/how-to-setup-freecodecamp-locally.md index d8c59c5ebb3..84a84272e1c 100644 --- a/docs/how-to-setup-freecodecamp-locally.md +++ b/docs/how-to-setup-freecodecamp-locally.md @@ -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.