From c5bf62fac0ed79d048b5022760a89c9878603f58 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Fri, 14 Jul 2023 11:04:53 -0700 Subject: [PATCH] docs(readme): add note on enabling long paths --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 2ead4920..ef1f25a2 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,13 @@ This means that: ### Quickstart +It highly recommended that you enable support for long paths in Windows by running the following command in an +Administrator Terminal before starting with this quickstart guide: + +```powershell +Set-ItemProperty 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value 1 +``` + Make sure that you have either the [Scoop Package Manager](https://scoop.sh) or WinGet installed, then run the following commands at a PowerShell prompt. If you are using WinGet, make sure that you open a new terminal window or reload your profile after running the installation steps. Since this is not required when using `scoop`, I personally recommend that