Commit c0c60472 authored by Pieter De Gendt's avatar Pieter De Gendt Committed by Benjamin Cabé
Browse files

doc: develop: getting_started: Add powershell tabs 



Activating the Python environment on Windows can be done in a regular
command line prompt, or in powershell. But the activation script is
different.
Add a code tabs to include the powershell alternative.

Signed-off-by: default avatarPieter De Gendt <pieter.degendt@basalte.be>
parent d1969bf0

doc/develop/getting_started/index.rst

+44 −16
Original line number Diff line number Diff line
@@ -160,9 +160,9 @@ The current minimum required version for the main dependencies are: 


         Therefore, we don't recommend using WSL when getting started.



      These instructions must be run in a ``cmd.exe`` command prompt terminal window.

      In modern version of Windows (10 and later) it is recommended to install the Windows Terminal

      application from the Microsoft Store. The required commands differ on PowerShell.

      application from the Microsoft Store. Instructions are provided for a ``cmd.exe`` or

      PowerShell command prompts.



      These instructions rely on `Chocolatey`_. If Chocolatey isn't an option,

      you can install dependencies from their respective websites and ensure
@@ -175,8 +175,9 @@ The current minimum required version for the main dependencies are: 


      #. `Install chocolatey`_.



      #. Open a ``cmd.exe`` terminal window as **Administrator**. To do so, press the Windows key,

         type ``cmd.exe``, right-click the :guilabel:`Command Prompt` search result, and choose

      #. Open a ``cmd.exe`` or PowerShell terminal window as **Administrator**.

         To do so, press the Windows key, type ``cmd.exe`` or PowerShell, right-click the

         :guilabel:`Command Prompt` or :guilabel:`PowerShell` search result, and choose

         :guilabel:`Run as Administrator`.



      #. Disable global confirmation to avoid having to confirm the
@@ -333,21 +334,34 @@ chosen. You'll also install Zephyr's additional Python dependencies in a 


   .. group-tab:: Windows



      #. Open a ``cmd.exe`` terminal window **as a regular user**

      #. Open a ``cmd.exe`` or PowerShell terminal window **as a regular user**



      #. Create a new virtual environment:



         .. code-block:: bat

         .. tabs::



            .. code-tab:: bat



               cd %HOMEPATH%

               python -m venv zephyrproject\.venv



            .. code-tab:: powershell



               cd $Env:HOMEPATH

               python -m venv zephyrproject\.venv



      #. Activate the virtual environment:



         .. code-block:: bat

         .. tabs::



            .. code-tab:: bat



               zephyrproject\.venv\Scripts\activate.bat



            .. code-tab:: powershell



               zephyrproject\.venv\Scripts\Activate.ps1



         Once activated your shell will be prefixed with ``(.venv)``. The

         virtual environment can be deactivated at any time by running

         ``deactivate``.
@@ -434,11 +448,18 @@ that are used to emulate, flash and debug Zephyr applications. 


      Install the Zephyr SDK using the ``west sdk install``.



         .. code-block:: bat

         .. tabs::



            .. code-tab:: bat



               cd %HOMEPATH%\zephyrproject\zephyr

               west sdk install



            .. code-tab:: powershell



               cd $Env:HOMEPATH\zephyrproject\zephyr

               west sdk install



      .. tip::



          Using the command options, you can specify the SDK installation destination
@@ -485,11 +506,18 @@ Build the :zephyr:code-sample:`blinky` with :ref:`west build <west-building>`, c 


   .. group-tab:: Windows



      .. code-block:: bat

      .. tabs::



         .. code-tab:: bat



            cd %HOMEPATH%\zephyrproject\zephyr

            west build -p always -b <your-board-name> samples\basic\blinky



         .. code-tab:: powershell



            cd $Env:HOMEPATH\zephyrproject\zephyr

            west build -p always -b <your-board-name> samples\basic\blinky



The ``-p always`` option forces a pristine build, and is recommended for new

users. Users may also use the ``-p auto`` option, which will use

heuristics to determine if a pristine build is required, such as when building

CRA Git | Maintained and supported by SUSTech CRA and CCSE