Skip to content

Commit 79f2098

Browse files
carlescufiAnas Nashif
authored andcommitted
doc: getting_started: Add WSL instructions
Having tried and tested building Zephyr using the standard SDK on Windows 10 using the new WSL (Windows Subsystem for Linux), add the documentation so that others can benefit from the functionality. Signed-off-by: Carles Cufi <[email protected]>
1 parent d056cec commit 79f2098

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

doc/getting_started/installation_win.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ Windows system with the latest updates installed.
2020
Installing Requirements and Dependencies
2121
****************************************
2222

23+
Using MSYS2
24+
===========
25+
2326
The Zephyr development environment on Windows relies on MSYS2, a modern UNIX
2427
environment for Windows. Follow the steps below to set it up:
2528

@@ -176,8 +179,29 @@ environment for Windows. Follow the steps below to set it up:
176179
This should check that all the tools and toolchain are set up correctly for
177180
your own Zephyr development.
178181

182+
Using Windows 10 WSL (Windows Subsystem for Linux)
183+
==================================================
184+
185+
If you are running a recent version of Windows 10 you can make use of the
186+
built-in functionality to natively run Ubuntu binaries directly on a standard
187+
command-prompt. This allows you to install the standard Zephyr SDK and build
188+
for all supported architectures without the need for a Virtual Machine.
189+
190+
#. Install Windows Subsystem for Linux (WSL) following the instructions on the
191+
official Microsoft website: `WSL Installation`_
192+
193+
.. note::
194+
For the Zephyr SDK to function properly you will need Windows 10
195+
build 15002 or greater. You can check which Windows 10 build you are
196+
running in the "About your PC" section of the System Settings.
197+
If you are running an older Windows 10 build you might need to install
198+
the Creator's Update.
199+
200+
#. Follow the instructions for Ubuntu detailed in the Zephyr Linux Getting
201+
Started Guide which can be found here: :ref:`installation_linux`
179202

180203
.. _GNU ARM Embedded: https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads
181204
.. _MSYS2 website: http://www.msys2.org/
182205
.. _ISSM Toolchain: https://software.intel.com/en-us/articles/issm-toolchain-only-download
183206
.. _Getting Started on Arduino 101 with ISSM: https://software.intel.com/en-us/articles/getting-started-arduino-101genuino-101-with-intel-system-studio-for-microcontrollers
207+
.. _WSL Installation: https://msdn.microsoft.com/en-us/commandline/wsl/install_guide

0 commit comments

Comments
 (0)