Skip to content

Commit c6c1501

Browse files
Marti Bolivarnashif
authored andcommitted
getting_started: building: fix inaccuracies
The building and running section is out of date, as Windows and macOS commands are available now. It also has some accuracies: - the following section describes how to build hello_world, not how to make a new application based on it - zephyr-env scripts do more than just set project-specific environment variables (they modify PATH on Unix, and may run arbitrary RC scripts on all platforms) Fix these issues. Signed-off-by: Marti Bolivar <[email protected]>
1 parent 64ab132 commit c6c1501

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

doc/getting_started/getting_started.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,27 +70,25 @@ Use the following procedures to create a new development environment.
7070
Building and Running an Application
7171
***********************************
7272

73-
Using the 'Hello World' sample application as a base model, the following
74-
section will describe the pieces necessary for creating a Zephyr application.
73+
Next, build a sample Zephyr application. You can then run it either in
74+
emulation or using POSIX APIs available on your host.
7575

76-
The processes to build and run a Zephyr application are the same across
77-
operating systems. Nevertheless, the commands needed do differ from one OS to
78-
the next. The following sections contain the commands used in a Linux
79-
development environment. If you are using macOS please use the appropriate
80-
commands for your OS.
76+
If your board is supported by Zephyr (see :ref:`boards` for a list),
77+
consult its documentation for flashing and running instructions.
8178

8279
Building a Sample Application
8380
=============================
8481

85-
To build an example application follow these steps:
82+
Follow these steps to build the :ref:`hello_world` sample application
83+
provided with Zephyr.
8684

8785
#. Navigate to the main project directory:
8886

8987
.. code-block:: console
9088
9189
cd zephyr
9290
93-
#. Set the project environment variables:
91+
#. Set up your build environment:
9492

9593
.. code-block:: console
9694

0 commit comments

Comments
 (0)