zephyr/samples/hello_world/README.rst

.. zephyr:code-sample:: hello_world
   :name: Hello World

   Print "Hello World" to the console.

Overview
********

A simple sample that can be used with any :ref:`supported board <boards>` and
prints "Hello World" to the console.

Building and Running
********************

This application can be built and executed on QEMU as follows:

.. zephyr-app-commands::
   :zephyr-app: samples/hello_world
   :host-os: unix
   :board: qemu_x86
   :goals: run
   :compact:

To build for another board, change "qemu_x86" above to that board's name.

Sample Output
=============

.. code-block:: console

    Hello World! x86

Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.
samples: hello_world: use zephyr:code-sample directive Adds missing code-sample directive to the Hello World sample in preparation for upcoming changes to the Zephyr documentation that will be leveraging the provided description and metadata. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org> 2024-09-12 04:26:10 +08:00			`.. zephyr:code-sample:: hello_world`
			`:name: Hello World`

			`Print "Hello World" to the console.`
boards: add arduino_due board documentation Change-Id: Id98671fd0a1e6eddd8368123c60f1452b84f8fde Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-01-15 07:39:24 +08:00
doc: hello world: move to rst and expand docuemntation Change-Id: Id623dd8d2f97836c0f970424d06d9d549065f7c5 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-01-05 21:56:21 +08:00			`Overview`
doc: fix .rst files canonical heading order The headings on some .rst files were not following the expected heading order of using # for h1, * for h2, = for h3, and - for h4 This patch fixes that, and the doc/templates/*.tmpl files created for folks to use as templates for creating board and sample docs. Change-Id: I0263b005648558d5ea41a681ceaa4798c9594dd9 Signed-off-by: David B. Kinder <david.b.kinder@intel.com> 2017-01-21 07:58:05 +08:00			`********`
doc: hello world: move to rst and expand docuemntation Change-Id: Id623dd8d2f97836c0f970424d06d9d549065f7c5 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-01-05 21:56:21 +08:00
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> 2020-04-18 02:18:22 +08:00			A simple sample that can be used with any :ref:`supported board <boards>` and
			`prints "Hello World" to the console.`
doc: hello world: move to rst and expand docuemntation Change-Id: Id623dd8d2f97836c0f970424d06d9d549065f7c5 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-01-05 21:56:21 +08:00
			`Building and Running`
doc: fix .rst files canonical heading order The headings on some .rst files were not following the expected heading order of using # for h1, * for h2, = for h3, and - for h4 This patch fixes that, and the doc/templates/*.tmpl files created for folks to use as templates for creating board and sample docs. Change-Id: I0263b005648558d5ea41a681ceaa4798c9594dd9 Signed-off-by: David B. Kinder <david.b.kinder@intel.com> 2017-01-21 07:58:05 +08:00			`********************`
doc: hello world: move to rst and expand docuemntation Change-Id: Id623dd8d2f97836c0f970424d06d9d549065f7c5 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-01-05 21:56:21 +08:00
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> 2020-04-18 02:18:22 +08:00			`This application can be built and executed on QEMU as follows:`
doc: hello world: move to rst and expand docuemntation Change-Id: Id623dd8d2f97836c0f970424d06d9d549065f7c5 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-01-05 21:56:21 +08:00
samples: misc: Convert doc to CMake Convert misc samples doc to CMake. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> 2017-11-12 17:11:39 +08:00			`.. zephyr-app-commands::`
			`:zephyr-app: samples/hello_world`
doc: getting_started: Support multi-OS instructions In order to be able to document the build on Windows and UNIX systems, slight variations are required on the app commands that are used throughout the documentation system. This includes getting rid of the prompt symbol and providing commands for both UNIX and Windows operating systems. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> 2018-01-18 00:32:31 +08:00			`:host-os: unix`
samples: misc: Convert doc to CMake Convert misc samples doc to CMake. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> 2017-11-12 17:11:39 +08:00			`:board: qemu_x86`
			`:goals: run`
			`:compact:`
doc: hello world: move to rst and expand docuemntation Change-Id: Id623dd8d2f97836c0f970424d06d9d549065f7c5 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-01-05 21:56:21 +08:00
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> 2020-04-18 02:18:22 +08:00			`To build for another board, change "qemu_x86" above to that board's name.`

doc: hello world: move to rst and expand docuemntation Change-Id: Id623dd8d2f97836c0f970424d06d9d549065f7c5 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-01-05 21:56:21 +08:00			`Sample Output`
doc: fix .rst files canonical heading order The headings on some .rst files were not following the expected heading order of using # for h1, * for h2, = for h3, and - for h4 This patch fixes that, and the doc/templates/*.tmpl files created for folks to use as templates for creating board and sample docs. Change-Id: I0263b005648558d5ea41a681ceaa4798c9594dd9 Signed-off-by: David B. Kinder <david.b.kinder@intel.com> 2017-01-21 07:58:05 +08:00			`=============`
doc: hello world: move to rst and expand docuemntation Change-Id: Id623dd8d2f97836c0f970424d06d9d549065f7c5 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-01-05 21:56:21 +08:00
			`.. code-block:: console`

			`Hello World! x86`
doc: add how to exit from QEMU in samples While trying out the hello_world sample built for QEMU, I was expecting the sample app to exit and I'd return to a command prompt. Nope. You need to exit QEMU manually, so add that step to the sample instructions. Looking around, there are more uses of QEMU like this that could use this added step after running the sample app. Signed-off-by: David B. Kinder <david.b.kinder@intel.com> 2019-08-29 06:46:09 +08:00
			Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.