diff --git a/docs/source/getting-started/windows/index.rst b/docs/source/getting-started/windows/index.rst index 9e6211793f..190eca6c08 100644 --- a/docs/source/getting-started/windows/index.rst +++ b/docs/source/getting-started/windows/index.rst @@ -3,18 +3,18 @@ Windows Installation .. highlight:: batch -This page describes how to install the required tools and obtain the current -release version of Sming using the `Chocolatey `__ package manager. +This page describes how to install the Sming framework and required tools for Windows. +See :doc:`manual` for details of what gets installed. -See also: +Sming requires GNU make and associated tools which are not well-supported by Windows, +so requires MinGW. +You may have a better experience using the :doc:`Windows Subsystem for Linux `. .. toctree:: - :titlesonly: - :maxdepth: 1 - - manual - wsl + :hidden: + :glob: + * Quick Install ------------- @@ -28,6 +28,13 @@ Paste the following text press enter:: curl -LO https://raw.githubusercontent.com/SmingHub/Sming/develop/Tools/choco-install.cmd && choco-install.cmd +This will install the `Chocolatey `__ package manager on your system, +then use it to install the required tools such as `GIT `. +The Sming framework is then installed + +We will make use of the `Chocolatey `__ package manager to install these, +if not already present on your system. + .. important:: After installation, please close the administrative command prompt and open a new, regular command shell.