diff --git a/doc/getting_started/index.rst b/doc/getting_started/index.rst index 8b8947ed272..2f94ffb1804 100644 --- a/doc/getting_started/index.rst +++ b/doc/getting_started/index.rst @@ -57,7 +57,9 @@ Next, you'll install some host dependencies using your package manager. .. group-tab:: Ubuntu - #. Use ``apt`` to install dependencies: + .. _install_dependencies_ubuntu: + + #. Use ``apt`` to install the required dependencies: .. code-block:: bash @@ -66,13 +68,13 @@ Next, you'll install some host dependencies using your package manager. python3-dev python3-pip python3-setuptools python3-tk python3-wheel xz-utils file \ make gcc gcc-multilib g++-multilib libsdl2-dev - #. Verify the version of cmake installed on your system using:: + #. Verify the version of cmake that is installed on your system by entering:: cmake --version - If it's not version 3.13.1 or higher, follow these steps to - add the `Kitware third-party apt repository `__ - to get an updated version of cmake. + The version must be 3.13.1 or later. If your version is older, complete the following + steps to add the `Kitware third-party apt repository `__, + which contains an updated version of cmake. a) Add the Kitware signing key: @@ -87,7 +89,7 @@ Next, you'll install some host dependencies using your package manager. sudo apt-add-repository 'deb https://apt.kitware.com/ubuntu/ bionic main' - c) Then install the updated cmake with ``apt``: + c) Then install the updated version of cmake with ``apt``: .. code-block:: bash @@ -96,13 +98,15 @@ Next, you'll install some host dependencies using your package manager. .. group-tab:: macOS + .. _install_dependencies_macos: + #. Install `Homebrew `_: .. code-block:: bash /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" - #. Use ``brew`` to install dependencies: + #. Use ``brew`` to install the required dependencies: .. code-block:: bash @@ -130,27 +134,29 @@ Next, you'll install some host dependencies using your package manager. |p| - #. `Install chocolatey`_ + .. _install_dependencies_windows: - #. Open an **Administrator** ``cmd.exe`` window: press the Windows key, - type "cmd.exe", right-click the result, and choose "Run as - Administrator". + #. `Install chocolatey`_. - #. Disable global confirmation to avoid having to confirm + #. Open a ``cmd.exe`` window as **Administrator**. To do so, press the Windows key, + type "cmd.exe", right-click the result, and choose :guilabel:`Run as + Administrator`. + + #. Disable global confirmation to avoid having to confirm the installation of individual programs: .. code-block:: console choco feature enable -n allowGlobalConfirmation - #. Use ``choco`` to install dependencies: + #. Use ``choco`` to install the required dependencies: .. code-block:: console choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System' choco install ninja gperf python git - #. Open a new ``cmd.exe`` window **as a regular user** to continue. + #. Close the window and open a new ``cmd.exe`` window **as a regular user** to continue. .. _Chocolatey: https://chocolatey.org/ .. _Install chocolatey: https://chocolatey.org/install