From a6b86446d45b1d5495db9e93524a81dc49c43695 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=AD=20Bol=C3=ADvar?= Date: Fri, 17 Apr 2020 11:18:22 -0700 Subject: [PATCH] doc: hello_world: touch up README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- samples/hello_world/README.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/samples/hello_world/README.rst b/samples/hello_world/README.rst index 70a819f949..ce5423d6f0 100644 --- a/samples/hello_world/README.rst +++ b/samples/hello_world/README.rst @@ -5,17 +5,14 @@ Hello World Overview ******** -A simple Hello World example that can be used with any supported board and -prints 'Hello World' to the console. This application can be built into modes: -* single thread -* multi threading +A simple sample that can be used with any :ref:`supported board ` and +prints "Hello World" to the console. Building and Running ******************** -This project outputs 'Hello World' to the console. It can be built and executed -on QEMU as follows: +This application can be built and executed on QEMU as follows: .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -24,6 +21,8 @@ on QEMU as follows: :goals: run :compact: +To build for another board, change "qemu_x86" above to that board's name. + Sample Output =============