Skip to content

Commit 78c9b10

Browse files
Merge pull request #4471 from aboutcode-org/1881_improve_doc_for_windows_installation
Improve wording for windows' installation #1881
2 parents 0b60c63 + 06f210a commit 78c9b10

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/source/getting-started/install.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ under assets options.
146146
sudo add-apt-repository ppa:deadsnakes/ppa --yes
147147
sudo apt-get install python3.9 python3.9-distutils
148148

149+
.. _linux_mac_app_install:
149150

150151
Installation on Linux and Mac
151152
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -212,7 +213,7 @@ Installation on Windows 10/11
212213

213214
.. note::
214215

215-
On Windows 10, double-click the new folder, select one of the files inside the folder
216+
On Windows, double-click the new folder, select one of the files inside the folder
216217
(e.g., 'setup.py'), and right-click.
217218

218219
- In the pop-up menu select 'Properties'.
@@ -259,6 +260,14 @@ Un-installation
259260
under a ScanCode-prefixed directory such as .scancode-tk or .cache/scancode-tk.
260261

261262

263+
.. note::
264+
265+
The above installation process can be used with **Command Prompt**
266+
``cmd``, and **PowerShell**. **Git Bash** is not tested and using it may
267+
introduce unexpected behavior. If you're using **Windows Subsystem for
268+
Linux** ``WSL2``, please refer to :ref:`linux_mac_app_install` section
269+
above.
270+
262271
----
263272

264273
.. _docker_install:

0 commit comments

Comments
 (0)