From 06f210a65fac54868d7d69381048950b56c05962 Mon Sep 17 00:00:00 2001 From: Chin Yeung Li Date: Fri, 11 Jul 2025 15:03:05 +0800 Subject: [PATCH] Improve wording for windows' installation #1881 Signed-off-by: Chin Yeung Li --- docs/source/getting-started/install.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/source/getting-started/install.rst b/docs/source/getting-started/install.rst index 95e64cfa2c..b4a072f49b 100644 --- a/docs/source/getting-started/install.rst +++ b/docs/source/getting-started/install.rst @@ -146,6 +146,7 @@ under assets options. sudo add-apt-repository ppa:deadsnakes/ppa --yes sudo apt-get install python3.9 python3.9-distutils +.. _linux_mac_app_install: Installation on Linux and Mac ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -212,7 +213,7 @@ Installation on Windows 10/11 .. note:: - On Windows 10, double-click the new folder, select one of the files inside the folder + On Windows, double-click the new folder, select one of the files inside the folder (e.g., 'setup.py'), and right-click. - In the pop-up menu select 'Properties'. @@ -259,6 +260,14 @@ Un-installation under a ScanCode-prefixed directory such as .scancode-tk or .cache/scancode-tk. +.. note:: + + The above installation process can be used with **Command Prompt** + ``cmd``, and **PowerShell**. **Git Bash** is not tested and using it may + introduce unexpected behavior. If you're using **Windows Subsystem for + Linux** ``WSL2``, please refer to :ref:`linux_mac_app_install` section + above. + ---- .. _docker_install: