1
- .. _ installing_zephyr_win :
1
+ .. _ win-setup-alts :
2
2
3
- Install Windows Host Dependencies
4
- #################################
3
+ Windows alternative setup instructions
4
+ ######################################
5
5
6
- This guide was tested on Windows versions 7, 8.1, and 10.
6
+ .. _ win-wsl :
7
7
8
- Update Your Operating System
9
- ****************************
10
-
11
- Before proceeding with the build, ensure that you are running your
12
- Windows system with the latest updates installed.
13
-
14
- .. _windows_requirements :
15
-
16
- Install Requirements and Dependencies
17
- *************************************
18
-
19
- .. NOTE FOR DOCS AUTHORS: DO NOT PUT DOCUMENTATION BUILD DEPENDENCIES HERE.
20
-
21
- This section is for dependencies to build Zephyr binaries, *NOT* this
22
- documentation. If you need to add a dependency only required for building
23
- the docs, add it to doc/README.rst. (This change was made following the
24
- introduction of LaTeX->PDF support for the docs, as the texlive footprint is
25
- massive and not needed by users not building PDF documentation.)
26
-
27
- There are 2 different ways of developing for Zephyr on Microsoft Windows:
28
-
29
- #. :ref: `windows_install_native ` (recommended)
30
- #. :ref: `windows_install_wsl `
31
-
32
- The first option is fully Windows native; the other requires emulation layers
33
- that may result in slower build times.
34
-
35
- .. _windows_install_native :
36
-
37
- Option 1: Windows Command Prompt
38
- ================================
39
-
40
- These instructions assume you are using the ``cmd.exe `` command prompt. Some of
41
- the details, such as setting environment variables, may differ if you are using
42
- PowerShell.
43
-
44
- The easiest way to install the native Windows dependencies is to first install
45
- `Chocolatey `_, a package manager for Windows. If you prefer to install
46
- dependencies manually, you can also download the required programs from their
47
- respective websites.
48
-
49
- .. note ::
50
- Chocolatey will properly set up your environment so tools can be
51
- found on your PATH. If you install programs manually, be sure to
52
- verify the programs can also be found on your PATH. For example,
53
- you may need to add ``C:\\Program Files\Git\bin `` after manually
54
- installing Git for Windows.
55
-
56
- .. note ::
57
- There are multiple ``set `` statements in this tutorial. You can avoid
58
- typing them every time by placing them inside a ``.cmd `` file and
59
- running that every time you open a command prompt.
60
-
61
- #. If you're behind a corporate firewall, you'll likely need to specify a
62
- proxy to get access to internet resources:
63
-
64
- .. code-block :: console
65
-
66
- set HTTP_PROXY=http://user:[email protected] :1234
67
- set HTTPS_PROXY=http://user:[email protected] :1234
68
-
69
- #. Install :program: `Chocolatey ` by following the instructions on the
70
- `Chocolatey install `_ page.
71
-
72
- #. Open a command prompt (``cmd.exe ``) as an **Administrator ** (press the
73
- Windows key, type "cmd.exe" in the prompt, then right-click the result and
74
- choose "Run as Administrator").
75
-
76
- #. Optionally disable global confirmation to avoid having to confirm
77
- installation of individual programs:
78
-
79
- .. code-block :: console
80
-
81
- choco feature enable -n allowGlobalConfirmation
82
-
83
- #. Install CMake:
84
-
85
- .. code-block :: console
86
-
87
- choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
88
-
89
- #. Install the rest of the tools:
90
-
91
- .. code-block :: console
92
-
93
- choco install git python ninja dtc-msys2 gperf
94
-
95
- #. Close the Administrator command prompt window.
96
-
97
- .. NOTE FOR DOCS AUTHORS: as a reminder, do *NOT* put dependencies for building
98
- the documentation itself here.
99
-
100
- .. _windows_install_wsl :
101
-
102
- Option 2: Windows 10 WSL (Windows Subsystem for Linux)
103
- ======================================================
8
+ Windows 10 WSL (Windows Subsystem for Linux)
9
+ ********************************************
104
10
105
11
If you are running a recent version of Windows 10 you can make use of the
106
12
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
126
32
.. NOTE FOR DOCS AUTHORS: as a reminder, do *NOT* put dependencies for building
127
33
the documentation itself here.
128
34
129
- .. _Chocolatey : https://chocolatey.org/
130
- .. _Chocolatey install : https://chocolatey.org/install
131
35
.. _Install the Windows Subsystem for Linux (WSL) : https://msdn.microsoft.com/en-us/commandline/wsl/install_guide
132
36
.. _Zephyr Issue 10420 : https://github.com/zephyrproject-rtos/zephyr/issues/10420
0 commit comments