michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: gsg: Remove duplicate information for Windows

Browse source 
The GSG already includes the setup instructions. Remove the
duplicate that existed in installation_win.rst.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2020-03-09 18:26:27 +01:00 • committed by Johan Hedberg
commit 4a45ceaf62
1 changed files with 6 additions and 102 deletions
Download patch file Download diff file Expand all files Collapse all files

108
doc/getting_started/installation_win.rst
View file

@ -1,106 +1,12 @@
.. _installing_zephyr_win: .. _win-setup-alts:
Install Windows Host Dependencies Windows alternative setup instructions
################################# ######################################
This guide was tested on Windows versions 7, 8.1, and 10. .. _win-wsl:
Update Your Operating System Windows 10 WSL (Windows Subsystem for Linux)
**************************** ********************************************
Before proceeding with the build, ensure that you are running your
Windows system with the latest updates installed.
.. _windows_requirements:
Install Requirements and Dependencies
*************************************
.. NOTE FOR DOCS AUTHORS: DO NOT PUT DOCUMENTATION BUILD DEPENDENCIES HERE.
This section is for dependencies to build Zephyr binaries, *NOT* this
documentation. If you need to add a dependency only required for building
the docs, add it to doc/README.rst. (This change was made following the
introduction of LaTeX->PDF support for the docs, as the texlive footprint is
massive and not needed by users not building PDF documentation.)
There are 2 different ways of developing for Zephyr on Microsoft Windows:
#. :ref:`windows_install_native` (recommended)
#. :ref:`windows_install_wsl`
The first option is fully Windows native; the other requires emulation layers
that may result in slower build times.
.. _windows_install_native:
Option 1: Windows Command Prompt
================================
These instructions assume you are using the ``cmd.exe`` command prompt. Some of
the details, such as setting environment variables, may differ if you are using
PowerShell.
The easiest way to install the native Windows dependencies is to first install
`Chocolatey`_, a package manager for Windows. If you prefer to install
dependencies manually, you can also download the required programs from their
respective websites.
.. note::
Chocolatey will properly set up your environment so tools can be
found on your PATH. If you install programs manually, be sure to
verify the programs can also be found on your PATH. For example,
you may need to add ``C:\\Program Files\Git\bin`` after manually
installing Git for Windows.
.. note::
There are multiple ``set`` statements in this tutorial. You can avoid
typing them every time by placing them inside a ``.cmd`` file and
running that every time you open a command prompt.
#. If you're behind a corporate firewall, you'll likely need to specify a
proxy to get access to internet resources:
.. code-block:: console
set HTTP_PROXY=http://user:password@proxy.mycompany.com:1234
set HTTPS_PROXY=http://user:password@proxy.mycompany.com:1234
#. Install :program:`Chocolatey` by following the instructions on the
`Chocolatey install`_ page.
#. Open a command prompt (``cmd.exe``) as an **Administrator** (press the
Windows key, type "cmd.exe" in the prompt, then right-click the result and
choose "Run as Administrator").
#. Optionally disable global confirmation to avoid having to confirm
installation of individual programs:
.. code-block:: console
choco feature enable -n allowGlobalConfirmation
#. Install CMake:
.. code-block:: console
choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
#. Install the rest of the tools:
.. code-block:: console
choco install git python ninja dtc-msys2 gperf
#. Close the Administrator command prompt window.
.. NOTE FOR DOCS AUTHORS: as a reminder, do *NOT* put dependencies for building
the documentation itself here.
.. _windows_install_wsl:
Option 2: Windows 10 WSL (Windows Subsystem for Linux)
======================================================
If you are running a recent version of Windows 10 you can make use of the If you are running a recent version of Windows 10 you can make use of the
built-in functionality to natively run Ubuntu binaries directly on a standard built-in functionality to natively run Ubuntu binaries directly on a standard
@ -126,7 +32,5 @@ command-prompt. This allows you to use software such as the :ref:`Zephyr SDK
.. NOTE FOR DOCS AUTHORS: as a reminder, do *NOT* put dependencies for building .. NOTE FOR DOCS AUTHORS: as a reminder, do *NOT* put dependencies for building
the documentation itself here. the documentation itself here.
.. _Chocolatey: https://chocolatey.org/
.. _Chocolatey install: https://chocolatey.org/install
.. _Install the Windows Subsystem for Linux (WSL): https://msdn.microsoft.com/en-us/commandline/wsl/install_guide .. _Install the Windows Subsystem for Linux (WSL): https://msdn.microsoft.com/en-us/commandline/wsl/install_guide
.. _Zephyr Issue 10420: https://github.com/zephyrproject-rtos/zephyr/issues/10420 .. _Zephyr Issue 10420: https://github.com/zephyrproject-rtos/zephyr/issues/10420