Skip to content

Commit

Permalink
Revise Windows install intro
Browse files Browse the repository at this point in the history
  • Loading branch information
mikee47 committed Jul 16, 2024
1 parent 092a359 commit 9128050
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions docs/source/getting-started/windows/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://chocolatey.org>`__ 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 <wsl>`.

.. toctree::
:titlesonly:
:maxdepth: 1

manual
wsl
:hidden:
:glob:

*

Quick Install
-------------
Expand All @@ -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 <https://chocolatey.org>`__ package manager on your system,
then use it to install the required tools such as `GIT <https://git-scm.com/>`.
The Sming framework is then installed

We will make use of the `Chocolatey <https://chocolatey.org>`__ 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.
Expand Down

0 comments on commit 9128050

Please sign in to comment.