samples: uuid: fix README issues
- use zephyr-app-commands - fix bullet list formatting - cross-reference UUID doxygen group Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
parent
7ae44ec850
commit
76c266c0a7
1 changed files with 12 additions and 10 deletions
|
@ -6,10 +6,11 @@
|
|||
Overview
|
||||
********
|
||||
|
||||
This sample app demonstrates the use of the UUID utilities to generate and manipulate UUIDs
|
||||
accordingly to IETF RFC 9562.
|
||||
This sample app demonstrates the use of the :c:group:`uuid` utilities to generate and manipulate
|
||||
UUIDs accordingly to IETF RFC 9562.
|
||||
|
||||
The following functionality is demonstrated:
|
||||
|
||||
- UUIDv4 generation
|
||||
- UUIDv5 generation from namespace and data
|
||||
- UUID conversion from/to string and to base64 and base64 URL safe formats
|
||||
|
@ -18,6 +19,7 @@ Requirements
|
|||
************
|
||||
|
||||
This sample relies on the following modules:
|
||||
|
||||
- MbedTLS for the UUIDv5 hash functions
|
||||
- Base64 for the base64 encoding of UUIDs
|
||||
- Entropy source for the pseudo-random generation of UUIDv4
|
||||
|
@ -26,11 +28,11 @@ Building and Running
|
|||
********************
|
||||
|
||||
Use the standard ``west`` commands to build and flash this application.
|
||||
For example for ``native_sim`` build with:
|
||||
```
|
||||
west build -p -b native_sim samples/subsys/uuid
|
||||
```
|
||||
Then run with:
|
||||
```
|
||||
west build -t run
|
||||
```
|
||||
For example, for ``native_sim``:
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/subsys/uuid
|
||||
:host-os: unix
|
||||
:board: native_sim
|
||||
:goals: run
|
||||
:compact:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue