5ca2eae5d5
Move all introductionary docs into one new section. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
747 lines
22 KiB
ReStructuredText
747 lines
22 KiB
ReStructuredText
.. _getting_started:
|
|
|
|
Getting Started Guide
|
|
#####################
|
|
|
|
Follow this guide to:
|
|
|
|
- Set up a command-line Zephyr development environment on Ubuntu, macOS, or
|
|
Windows (instructions for other Linux distributions are discussed in
|
|
:ref:`installation_linux`)
|
|
- Get the source code
|
|
- Build, flash, and run a sample application
|
|
|
|
.. _host_setup:
|
|
|
|
.. rst-class:: numbered-step
|
|
|
|
Select and Update OS
|
|
********************
|
|
|
|
Click the operating system you are using.
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Ubuntu
|
|
|
|
This guide covers Ubuntu version 18.04 LTS and later.
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo apt update
|
|
sudo apt upgrade
|
|
|
|
.. group-tab:: macOS
|
|
|
|
On macOS Mojave or later, select *System Preferences* >
|
|
*Software Update*. Click *Update Now* if necessary.
|
|
|
|
On other versions, see `this Apple support topic
|
|
<https://support.apple.com/en-us/HT201541>`_.
|
|
|
|
.. group-tab:: Windows
|
|
|
|
Select *Start* > *Settings* > *Update & Security* > *Windows Update*.
|
|
Click *Check for updates* and install any that are available.
|
|
|
|
.. _install-required-tools:
|
|
|
|
.. rst-class:: numbered-step
|
|
|
|
Install dependencies
|
|
********************
|
|
|
|
Next, you'll install some host dependencies using your package manager.
|
|
|
|
The current minimum required version for the main dependencies are:
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Tool
|
|
- Min. Version
|
|
|
|
* - `CMake <https://cmake.org/>`_
|
|
- 3.20.0
|
|
|
|
* - `Python <https://www.python.org/>`_
|
|
- 3.6
|
|
|
|
* - `Devicetree compiler <https://www.devicetree.org/>`_
|
|
- 1.4.6
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Ubuntu
|
|
|
|
.. _install_dependencies_ubuntu:
|
|
|
|
#. Download, inspect and execute the Kitware archive script to add the
|
|
Kitware APT repository to your sources list.
|
|
A detailed explanation of ``kitware-archive.sh`` can be found here
|
|
`kitware third-party apt repository <https://apt.kitware.com/>`_:
|
|
|
|
.. code-block:: bash
|
|
|
|
wget https://apt.kitware.com/kitware-archive.sh
|
|
sudo bash kitware-archive.sh
|
|
|
|
#. Use ``apt`` to install the required dependencies:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo apt install --no-install-recommends git cmake ninja-build gperf \
|
|
ccache dfu-util device-tree-compiler wget \
|
|
python3-dev python3-pip python3-setuptools python3-tk python3-wheel xz-utils file \
|
|
make gcc gcc-multilib g++-multilib libsdl2-dev
|
|
|
|
#. Verify the versions of the main dependencies installed on your system by entering::
|
|
|
|
cmake --version
|
|
python3 --version
|
|
dtc --version
|
|
|
|
Check those against the versions in the table in the beginning of this section.
|
|
Refer to the :ref:`installation_linux` page for additional information on updating
|
|
the dependencies manually.
|
|
|
|
.. group-tab:: macOS
|
|
|
|
.. _install_dependencies_macos:
|
|
|
|
#. Install `Homebrew <https://brew.sh/>`_:
|
|
|
|
.. code-block:: bash
|
|
|
|
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
|
|
|
#. Use ``brew`` to install the required dependencies:
|
|
|
|
.. code-block:: bash
|
|
|
|
brew install cmake ninja gperf python3 ccache qemu dtc wget
|
|
|
|
.. group-tab:: Windows
|
|
|
|
.. note::
|
|
|
|
Due to issues finding executables, the Zephyr Project doesn't
|
|
currently support application flashing using the `Windows Subsystem
|
|
for Linux (WSL)
|
|
<https://msdn.microsoft.com/en-us/commandline/wsl/install_guide>`_
|
|
(WSL).
|
|
|
|
Therefore, we don't recommend using WSL when getting started.
|
|
|
|
These instructions must be run in a ``cmd.exe`` command prompt. The
|
|
required commands differ on PowerShell.
|
|
|
|
These instructions rely on `Chocolatey`_. If Chocolatey isn't an option,
|
|
you can install dependencies from their respective websites and ensure
|
|
the command line tools are on your :envvar:`PATH` :ref:`environment
|
|
variable <env_vars>`.
|
|
|
|
|p|
|
|
|
|
.. _install_dependencies_windows:
|
|
|
|
#. `Install chocolatey`_.
|
|
|
|
#. 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 the required dependencies:
|
|
|
|
.. code-block:: console
|
|
|
|
choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
|
|
choco install ninja gperf python git dtc-msys2 wget unzip
|
|
|
|
#. 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
|
|
|
|
.. _get_the_code:
|
|
.. _clone-zephyr:
|
|
.. _install_py_requirements:
|
|
.. _gs_python_deps:
|
|
|
|
.. rst-class:: numbered-step
|
|
|
|
Get Zephyr and install Python dependencies
|
|
******************************************
|
|
|
|
Next, clone Zephyr and its :ref:`modules <modules>` into a new :ref:`west
|
|
<west>` workspace named :file:`zephyrproject`. You'll also install Zephyr's
|
|
additional Python dependencies.
|
|
|
|
Python is used by the ``west`` meta-tool as well as by many scripts invoked by
|
|
the build system. It is easy to run into package incompatibilities when
|
|
installing dependencies at a system or user level. This situation can happen,
|
|
for example, if working on multiple Zephyr versions at the same time. For this
|
|
reason it is suggested to use `Python virtual environments`_.
|
|
|
|
.. _Python virtual environments: https://docs.python.org/3/library/venv.html
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Ubuntu
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Install globally
|
|
|
|
#. Install west, and make sure :file:`~/.local/bin` is on your
|
|
:envvar:`PATH` :ref:`environment variable <env_vars>`:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip3 install --user -U west
|
|
echo 'export PATH=~/.local/bin:"$PATH"' >> ~/.bashrc
|
|
source ~/.bashrc
|
|
|
|
#. Get the Zephyr source code:
|
|
|
|
.. code-block:: bash
|
|
|
|
west init ~/zephyrproject
|
|
cd ~/zephyrproject
|
|
west update
|
|
|
|
#. Export a :ref:`Zephyr CMake package <cmake_pkg>`. This allows CMake to
|
|
automatically load boilerplate code required for building Zephyr
|
|
applications.
|
|
|
|
.. code-block:: console
|
|
|
|
west zephyr-export
|
|
|
|
#. Zephyr's ``scripts/requirements.txt`` file declares additional Python
|
|
dependencies. Install them with ``pip3``.
|
|
|
|
.. code-block:: bash
|
|
|
|
pip3 install --user -r ~/zephyrproject/zephyr/scripts/requirements.txt
|
|
|
|
.. group-tab:: Install within virtual environment
|
|
|
|
#. Create a new virtual environment:
|
|
|
|
.. code-block:: bash
|
|
|
|
python3 -m venv ~/zephyrproject/.venv
|
|
|
|
#. Activate the virtual environment:
|
|
|
|
.. code-block:: bash
|
|
|
|
source ~/zephyrproject/.venv/bin/activate
|
|
|
|
Once activated your shell will be prefixed with ``(.venv)``. The
|
|
virtual environment can be deactivated at any time by running
|
|
``deactivate``.
|
|
|
|
.. note::
|
|
|
|
Remember to activate the virtual environment every time you
|
|
start working.
|
|
|
|
#. Install west:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install west
|
|
|
|
#. Get the Zephyr source code:
|
|
|
|
.. code-block:: bash
|
|
|
|
west init ~/zephyrproject
|
|
cd ~/zephyrproject
|
|
west update
|
|
|
|
#. Export a :ref:`Zephyr CMake package <cmake_pkg>`. This allows CMake to
|
|
automatically load boilerplate code required for building Zephyr
|
|
applications.
|
|
|
|
.. code-block:: console
|
|
|
|
west zephyr-export
|
|
|
|
#. Zephyr's ``scripts/requirements.txt`` file declares additional Python
|
|
dependencies. Install them with ``pip``.
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install -r ~/zephyrproject/zephyr/scripts/requirements.txt
|
|
|
|
.. group-tab:: macOS
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Install globally
|
|
|
|
#. Install west:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip3 install -U west
|
|
|
|
#. Get the Zephyr source code:
|
|
|
|
.. code-block:: bash
|
|
|
|
west init ~/zephyrproject
|
|
cd ~/zephyrproject
|
|
west update
|
|
|
|
#. Export a :ref:`Zephyr CMake package <cmake_pkg>`. This allows CMake to
|
|
automatically load boilerplate code required for building Zephyr
|
|
applications.
|
|
|
|
.. code-block:: console
|
|
|
|
west zephyr-export
|
|
|
|
#. Zephyr's ``scripts/requirements.txt`` file declares additional Python
|
|
dependencies. Install them with ``pip3``.
|
|
|
|
.. code-block:: bash
|
|
|
|
pip3 install -r ~/zephyrproject/zephyr/scripts/requirements.txt
|
|
|
|
.. group-tab:: Install within virtual environment
|
|
|
|
#. Create a new virtual environment:
|
|
|
|
.. code-block:: bash
|
|
|
|
python3 -m venv ~/zephyrproject/.venv
|
|
|
|
#. Activate the virtual environment:
|
|
|
|
.. code-block:: bash
|
|
|
|
source ~/zephyrproject/.venv/bin/activate
|
|
|
|
Once activated your shell will be prefixed with ``(.venv)``. The
|
|
virtual environment can be deactivated at any time by running
|
|
``deactivate``.
|
|
|
|
.. note::
|
|
|
|
Remember to activate the virtual environment every time you
|
|
start working.
|
|
|
|
#. Install west:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install west
|
|
|
|
#. Get the Zephyr source code:
|
|
|
|
.. code-block:: bash
|
|
|
|
west init ~/zephyrproject
|
|
cd ~/zephyrproject
|
|
west update
|
|
|
|
#. Export a :ref:`Zephyr CMake package <cmake_pkg>`. This allows CMake to
|
|
automatically load boilerplate code required for building Zephyr
|
|
applications.
|
|
|
|
.. code-block:: console
|
|
|
|
west zephyr-export
|
|
|
|
#. Zephyr's ``scripts/requirements.txt`` file declares additional Python
|
|
dependencies. Install them with ``pip``.
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install -r ~/zephyrproject/zephyr/scripts/requirements.txt
|
|
|
|
.. group-tab:: Windows
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Install globally
|
|
|
|
#. Install west:
|
|
|
|
.. code-block:: bat
|
|
|
|
pip3 install -U west
|
|
|
|
#. Get the Zephyr source code:
|
|
|
|
.. code-block:: bat
|
|
|
|
cd %HOMEPATH%
|
|
west init zephyrproject
|
|
cd zephyrproject
|
|
west update
|
|
|
|
#. Export a :ref:`Zephyr CMake package <cmake_pkg>`. This allows CMake to
|
|
automatically load boilerplate code required for building Zephyr
|
|
applications.
|
|
|
|
.. code-block:: bat
|
|
|
|
west zephyr-export
|
|
|
|
#. Zephyr's ``scripts\requirements.txt`` file declares additional Python
|
|
dependencies. Install them with ``pip3``.
|
|
|
|
.. code-block:: bat
|
|
|
|
pip3 install -r %HOMEPATH%\zephyrproject\zephyr\scripts\requirements.txt
|
|
|
|
.. group-tab:: Install within virtual environment
|
|
|
|
#. Create a new virtual environment:
|
|
|
|
.. code-block:: bat
|
|
|
|
cd %HOMEPATH%
|
|
python3 -m venv zephyrproject\.venv
|
|
|
|
#. Activate the virtual environment:
|
|
|
|
.. code-block:: bat
|
|
|
|
:: cmd.exe
|
|
zephyrproject\.venv\Scripts\activate.bat
|
|
:: 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``.
|
|
|
|
.. note::
|
|
|
|
Remember to activate the virtual environment every time you
|
|
start working.
|
|
|
|
#. Install west:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install west
|
|
|
|
#. Get the Zephyr source code:
|
|
|
|
.. code-block:: bash
|
|
|
|
west init zephyrproject
|
|
cd zephyrproject
|
|
west update
|
|
|
|
#. Export a :ref:`Zephyr CMake package <cmake_pkg>`. This allows CMake to
|
|
automatically load boilerplate code required for building Zephyr
|
|
applications.
|
|
|
|
.. code-block:: console
|
|
|
|
west zephyr-export
|
|
|
|
#. Zephyr's ``scripts\requirements.txt`` file declares additional Python
|
|
dependencies. Install them with ``pip``.
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install -r %HOMEPATH%\zephyrproject\zephyr\scripts\requirements.txt
|
|
|
|
.. rst-class:: numbered-step
|
|
|
|
Install a Toolchain
|
|
*******************
|
|
|
|
A toolchain provides a compiler, assembler, linker, and other programs required
|
|
to build Zephyr applications.
|
|
|
|
The Zephyr Software Development Kit (SDK) contains toolchains for each of
|
|
Zephyr's supported architectures. It also includes additional host tools, such
|
|
as custom QEMU and OpenOCD builds.
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Ubuntu
|
|
|
|
#. Download and verify the `latest Zephyr SDK bundle
|
|
<https://github.com/zephyrproject-rtos/sdk-ng/releases>`_:
|
|
|
|
.. code-block:: bash
|
|
|
|
cd ~
|
|
wget https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.14.0/zephyr-sdk-0.14.0_linux-x86_64.tar.gz
|
|
wget -O - https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.14.0/sha256.sum | shasum --check --ignore-missing
|
|
|
|
If your host architecture is 64-bit ARM (for example, Raspberry Pi), replace ``x86_64``
|
|
with ``aarch64`` in order to download the 64-bit ARM Linux SDK.
|
|
|
|
#. Extract the Zephyr SDK bundle archive:
|
|
|
|
.. code-block:: bash
|
|
|
|
tar xvf zephyr-sdk-0.14.0_linux-x86_64.tar.gz
|
|
|
|
.. note::
|
|
It is recommended to extract the Zephyr SDK bundle at one of the following locations:
|
|
|
|
* ``$HOME``
|
|
* ``$HOME/.local``
|
|
* ``$HOME/.local/opt``
|
|
* ``$HOME/bin``
|
|
* ``/opt``
|
|
* ``/usr/local``
|
|
|
|
The Zephyr SDK bundle archive contains the ``zephyr-sdk-0.14.0`` directory and, when
|
|
extracted under ``$HOME``, the resulting installation path will be
|
|
``$HOME/zephyr-sdk-0.14.0``.
|
|
|
|
#. Run the Zephyr SDK bundle setup script:
|
|
|
|
.. code-block:: bash
|
|
|
|
cd zephyr-sdk-0.14.0
|
|
./setup.sh
|
|
|
|
.. note::
|
|
You only need to run the setup script once after extracting the Zephyr SDK bundle.
|
|
|
|
You must rerun the setup script if you relocate the Zephyr SDK bundle directory after
|
|
the initial setup.
|
|
|
|
#. Install `udev <https://en.wikipedia.org/wiki/Udev>`_ rules, which
|
|
allow you to flash most Zephyr boards as a regular user:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo cp ~/zephyr-sdk-0.14.0/sysroots/x86_64-pokysdk-linux/usr/share/openocd/contrib/60-openocd.rules /etc/udev/rules.d
|
|
sudo udevadm control --reload
|
|
|
|
.. group-tab:: macOS
|
|
|
|
#. Download and verify the `latest Zephyr SDK bundle
|
|
<https://github.com/zephyrproject-rtos/sdk-ng/releases>`_:
|
|
|
|
.. code-block:: bash
|
|
|
|
cd ~
|
|
wget https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.14.0/zephyr-sdk-0.14.0_macos-x86_64.tar.gz
|
|
wget -O - https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.14.0/sha256.sum | shasum --check --ignore-missing
|
|
|
|
If your host architecture is 64-bit ARM (Apple Silicon, also known as M1), replace
|
|
``x86_64`` with ``aarch64`` in order to download the 64-bit ARM macOS SDK.
|
|
|
|
#. Extract the Zephyr SDK bundle archive:
|
|
|
|
.. code-block:: bash
|
|
|
|
tar xvf zephyr-sdk-0.14.0_macos-x86_64.tar.gz
|
|
|
|
.. note::
|
|
It is recommended to extract the Zephyr SDK bundle at one of the following locations:
|
|
|
|
* ``$HOME``
|
|
* ``$HOME/.local``
|
|
* ``$HOME/.local/opt``
|
|
* ``$HOME/bin``
|
|
* ``/opt``
|
|
* ``/usr/local``
|
|
|
|
The Zephyr SDK bundle archive contains the ``zephyr-sdk-0.14.0`` directory and, when
|
|
extracted under ``$HOME``, the resulting installation path will be
|
|
``$HOME/zephyr-sdk-0.14.0``.
|
|
|
|
#. Run the Zephyr SDK bundle setup script:
|
|
|
|
.. code-block:: bash
|
|
|
|
cd zephyr-sdk-0.14.0
|
|
./setup.sh
|
|
|
|
.. note::
|
|
You only need to run the setup script once after extracting the Zephyr SDK bundle.
|
|
|
|
You must rerun the setup script if you relocate the Zephyr SDK bundle directory after
|
|
the initial setup.
|
|
|
|
.. group-tab:: Windows
|
|
|
|
#. Open a ``cmd.exe`` window by pressing the Windows key typing "cmd.exe".
|
|
|
|
#. Download the `latest Zephyr SDK bundle
|
|
<https://github.com/zephyrproject-rtos/sdk-ng/releases>`_:
|
|
|
|
.. code-block:: console
|
|
|
|
cd %HOMEPATH%
|
|
wget https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.14.0/zephyr-sdk-0.14.0_windows-x86_64.zip
|
|
|
|
#. Extract the Zephyr SDK bundle archive:
|
|
|
|
.. code-block:: console
|
|
|
|
unzip zephyr-sdk-0.14.0_windows-x86_64.zip
|
|
|
|
.. note::
|
|
It is recommended to extract the Zephyr SDK bundle at one of the following locations:
|
|
|
|
* ``%HOMEPATH%``
|
|
* ``%PROGRAMFILES%``
|
|
|
|
The Zephyr SDK bundle archive contains the ``zephyr-sdk-0.14.0`` directory and, when
|
|
extracted under ``%HOMEPATH%``, the resulting installation path will be
|
|
``%HOMEPATH%\zephyr-sdk-0.14.0``.
|
|
|
|
#. Run the Zephyr SDK bundle setup script:
|
|
|
|
.. code-block:: console
|
|
|
|
cd zephyr-sdk-0.14.0
|
|
setup.cmd
|
|
|
|
.. note::
|
|
You only need to run the setup script once after extracting the Zephyr SDK bundle.
|
|
|
|
You must rerun the setup script if you relocate the Zephyr SDK bundle directory after
|
|
the initial setup.
|
|
|
|
.. _getting_started_run_sample:
|
|
|
|
.. rst-class:: numbered-step
|
|
|
|
Build the Blinky Sample
|
|
***********************
|
|
|
|
.. note::
|
|
|
|
Blinky is compatible with most, but not all, :ref:`boards`. If your board
|
|
does not meet Blinky's :ref:`blinky-sample-requirements`, then
|
|
:ref:`hello_world` is a good alternative.
|
|
|
|
Build the :ref:`blinky-sample` with :ref:`west build <west-building>`, changing
|
|
``<your-board-name>`` appropriately for your board:
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Ubuntu
|
|
|
|
.. code-block:: bash
|
|
|
|
cd ~/zephyrproject/zephyr
|
|
west build -p auto -b <your-board-name> samples/basic/blinky
|
|
|
|
.. group-tab:: macOS
|
|
|
|
.. code-block:: bash
|
|
|
|
cd ~/zephyrproject/zephyr
|
|
west build -p auto -b <your-board-name> samples/basic/blinky
|
|
|
|
.. group-tab:: Windows
|
|
|
|
.. code-block:: bat
|
|
|
|
cd %HOMEPATH%\zephyrproject\zephyr
|
|
west build -p auto -b <your-board-name> samples\basic\blinky
|
|
|
|
The ``-p auto`` option automatically cleans byproducts from a previous build
|
|
if necessary, which is useful if you try building another sample.
|
|
|
|
.. rst-class:: numbered-step
|
|
|
|
Flash the Sample
|
|
****************
|
|
|
|
Connect your board, usually via USB, and turn it on if there's a power switch.
|
|
If in doubt about what to do, check your board's page in :ref:`boards`.
|
|
|
|
Then flash the sample using :ref:`west flash <west-flashing>`:
|
|
|
|
.. code-block:: console
|
|
|
|
west flash
|
|
|
|
You may need to install additional :ref:`host tools <flash-debug-host-tools>`
|
|
required by your board. The ``west flash`` command will print an error if any
|
|
required dependencies are missing.
|
|
|
|
If you're using blinky, the LED will start to blink as shown in this figure:
|
|
|
|
.. figure:: img/ReelBoard-Blinky.png
|
|
:width: 400px
|
|
:name: reelboard-blinky
|
|
|
|
Phytec :ref:`reel_board <reel_board>` running blinky
|
|
|
|
Next Steps
|
|
**********
|
|
|
|
Here are some next steps for exploring Zephyr:
|
|
|
|
* Try other :ref:`samples-and-demos`
|
|
* Learn about :ref:`application` and the :ref:`west <west>` tool
|
|
* Find out about west's :ref:`flashing and debugging <west-build-flash-debug>`
|
|
features, or more about :ref:`flashing_and_debugging` in general
|
|
* Check out :ref:`beyond-GSG` for additional setup alternatives and ideas
|
|
* Discover :ref:`project-resources` for getting help from the Zephyr
|
|
community
|
|
|
|
.. _help:
|
|
|
|
Asking for Help
|
|
***************
|
|
|
|
You can ask for help on a mailing list or on Discord. Please send bug reports and
|
|
feature requests to GitHub.
|
|
|
|
* **Mailing Lists**: users@lists.zephyrproject.org is usually the right list to
|
|
ask for help. `Search archives and sign up here`_.
|
|
* **Discord**: You can join with this `Discord invite`_.
|
|
* **GitHub**: Use `GitHub issues`_ for bugs and feature requests.
|
|
|
|
How to Ask
|
|
==========
|
|
|
|
.. important::
|
|
|
|
Please search this documentation and the mailing list archives first. Your
|
|
question may have an answer there.
|
|
|
|
Don't just say "this isn't working" or ask "is this working?". Include as much
|
|
detail as you can about:
|
|
|
|
#. What you want to do
|
|
#. What you tried (commands you typed, etc.)
|
|
#. What happened (output of each command, etc.)
|
|
|
|
Use Copy/Paste
|
|
==============
|
|
|
|
Please **copy/paste text** instead of taking a picture or a screenshot of it.
|
|
Text includes source code, terminal commands, and their output.
|
|
|
|
Doing this makes it easier for people to help you, and also helps other users
|
|
search the archives.
|
|
|
|
When copy/pasting more than 5 lines of text into Discord, create a snippet using
|
|
three backticks to delimit the snippet.
|
|
|
|
.. _Search archives and sign up here: https://lists.zephyrproject.org/g/users
|
|
.. _Discord invite: https://chat.zephyrproject.org
|
|
.. _GitHub issues: https://github.com/zephyrproject-rtos/zephyr/issues
|