Lines Matching +full:repo +full:- +full:cache
1 .. _beyond-gsg:
6 The :ref:`getting_started` gives a straight-forward path to set up
11 .. _python-pip:
22 ``--user`` flag to the ``pip3`` command when installing new packages. This is
25 information about pip\ [#pip]_, including `information on -\\-user`_.
27 - On Linux, make sure ``~/.local/bin`` is at the front of your :envvar:`PATH`
28 :ref:`environment variable <env_vars>`, or programs installed with ``--user``
29 won't be found. Installing with ``--user`` avoids conflicts between pip
30 and the system package manager, and is the default on Debian-based
33 - On macOS, `Homebrew disables -\\-user`_.
35 - On Windows, see the `Installing Packages`_ information on ``--user`` if you
38 On all operating systems, pip's ``-U`` flag installs or updates the package if the
63 a cross-compiler and related tools which are different from the compiler
70 :ref:`board-level documentation <boards>`).
103 The Zephyr project source is maintained in the `GitHub zephyr repo
104 <https://github.com/zephyrproject-rtos/zephyr>`_. External modules used
106 <https://github.com/zephyrproject-rtos/>`_. Because of these
107 dependencies, it's convenient to use the Zephyr-created :ref:`west
109 code. See :ref:`west-basics` for more details.
116 .. code-block:: console
124 repo.
140 ``west packages pip --install`` will make sure these are up-to-date.
142 .. code-block:: console
148 west packages pip --install
156 .. _gs-board-aliases:
165 .. code-block:: cmake
168 # sets BOARD_ALIAS=foo in the CMake cache.
176 ``cmake -DBOARD=pca10028`` and ``west -b pca10028``.
191 Let's build the :zephyr:code-sample:`blinky` sample application.
202 .. code-block:: console
208 .. zephyr-app-commands::
209 :zephyr-app: samples/basic/blinky
219 documented in :zephyr:code-sample-category:`samples`.
223 add the parameter ``-p=auto`` to ``west build`` to clean out settings
230 ``west flash``. This may require board-specific tool installation and
236 .. _setting-udev-rules:
249 permission by non-root users to certain USB-connected devices.
251 The OpenOCD (On-Chip Debugger) project conveniently provides a rules
252 file that defined board-specific rules for most Zephyr-supported
253 arm-based boards, so we recommend installing this rules
254 file by downloading it from their sourceforge repo, or if you've
261 …wget -O 60-openocd.rules https://sf.net/p/openocd/code/ci/master/tree/contrib/60-openocd.rules?for…
262 sudo cp 60-openocd.rules /etc/udev/rules.d
266 …sudo cp ${ZEPHYR_SDK_INSTALL_DIR}/sysroots/x86_64-pokysdk-linux/usr/share/openocd/contrib/60-openo…
270 sudo udevadm control --reload
274 board-specific documentation (:ref:`boards`) for further information if
282 the x86 or ARM Cortex-M3 architectures. (QEMU is included with the Zephyr
292 For example, you can build and run the :zephyr:code-sample:`hello_world` sample using
295 .. zephyr-app-commands::
296 :zephyr-app: samples/hello_world
297 :host-os: unix
301 To exit QEMU, type :kbd:`Ctrl-a`, then :kbd:`x`.
303 Use ``qemu_cortex_m3`` to target an emulated Arm Cortex-M3 sample.
311 on Linux. See :ref:`native_sim` for more information. On 64-bit host operating systems, you
312 need to install a 32-bit C library, or build targeting :ref:`native_sim/native/64<native_sim32_64>`.
316 .. zephyr-app-commands::
317 :zephyr-app: samples/hello_world
318 :host-os: unix
324 .. code-block:: console
326 west build -t run
330 Press :kbd:`Ctrl-C` to exit.
332 You can run ``./build/zephyr/zephyr.exe --help`` to get a list of available
358 running different Zephyr-based binaries on CPU cores of differing
363 .. _information on -\\-user:
364 https://packaging.python.org/tutorials/installing-packages/#installing-to-the-user-site
365 .. _Homebrew disables -\\-user:
366 https://docs.brew.sh/Homebrew-and-Python#note-on-pip-install---user
368 https://packaging.python.org/tutorials/installing-packages/