README.rst
1.. zephyr:code-sample:: hello-bindesc
2 :name: Binary descriptors "Hello World"
3 :relevant-api: bindesc_define
4
5 Set and access binary descriptors for a basic Zephyr application.
6
7Overview
8********
9
10A simple sample of :ref:`binary descriptor <binary_descriptors>` definition and usage.
11
12Building and Running
13********************
14
15Follow these steps to build the ``hello_bindesc`` sample application:
16
17.. zephyr-app-commands::
18 :zephyr-app: samples/subsys/bindesc/hello_bindesc
19 :board: <board to use>
20 :goals: build
21 :compact:
22
23To dump all binary descriptors in the image, run:
24
25.. code-block:: bash
26
27 west bindesc dump build/zephyr/zephyr.bin
28
29(Note: you can also dump the contents of ``zephyr.elf``, if your build system
30does not produce a ``*.bin`` file, e.g. compiling for ``native_sim``.)
31
32For more details see :ref:`binary_descriptors` and :ref:`west-bindesc`.
33