zephyr/samples/modules/compression/lz4/README.rst
Parthiban Nallathambi f8c51d70c4 samples: add steps to add lz4 into west manifest
lz4 is moved as optional module, add step in README to add
as project filter to include into west manifest.

Fixes: https://github.com/zephyrproject-rtos/zephyr/issues/65127

Signed-off-by: Parthiban Nallathambi <parthiban@linumiz.com>
2024-08-12 19:24:15 -04:00

31 lines
648 B
ReStructuredText

.. _lz4:
LZ4
###
Overview
********
A simple sample that can be used with any :ref:`supported board <boards>` and
compress & decompress the user data to the console.
Building and Running
********************
Add the lz4 module to your West manifest and pull it:
.. code-block:: console
west config manifest.project-filter -- +lz4
west update
The sample can be built and executed on nrf52840dk/nrf52840 as follows:
.. zephyr-app-commands::
:zephyr-app: samples/compression/lz4
:board: nrf52840dk/nrf52840
:goals: build flash
:compact:
To build for another board, change "nrf52840dk/nrf52840" above to that board's name.