Skip to content

Commit 05461fe

Browse files
doc: hello_world: touch up README
Since this is such a basic sample, it's worth nitpicking the wording a bit: - Add a link to the supported boards, since many first time users will not know where it is and may start near here. - Remove the single and multi threaded note. There's no information on how to build it in either of these two modes or what the default is, so it feels like a distraction for such a basic sample. - Give a clue about how to build for another board. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
1 parent 7275d60 commit 05461fe

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

samples/hello_world/README.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,14 @@ Hello World
55

66
Overview
77
********
8-
A simple Hello World example that can be used with any supported board and
9-
prints 'Hello World' to the console. This application can be built into modes:
108

11-
* single thread
12-
* multi threading
9+
A simple sample that can be used with any :ref:`supported board <boards>` and
10+
prints "Hello World" to the console.
1311

1412
Building and Running
1513
********************
1614

17-
This project outputs 'Hello World' to the console. It can be built and executed
18-
on QEMU as follows:
15+
This application can be built and executed on QEMU as follows:
1916

2017
.. zephyr-app-commands::
2118
:zephyr-app: samples/hello_world
@@ -24,6 +21,8 @@ on QEMU as follows:
2421
:goals: run
2522
:compact:
2623

24+
To build for another board, change "qemu_x86" above to that board's name.
25+
2726
Sample Output
2827
=============
2928

0 commit comments

Comments
 (0)