patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

samples: basic: Convert doc to CMake

Browse source 
Convert doc for samples/basic to CMake.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2017-11-12 10:12:44 +01:00 committed by Anas Nashif
parent ece86b23ac
commit 08183f7e73
8 changed files with 50 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
samples/basic/blink_led/README.rst
View file

@ -41,11 +41,11 @@ Building and Running
This sample can be built for multiple boards, in this example we will build it
for the arduino_101 board:
.. code-block:: console
$ cd samples/basic/blink_led
$ make BOARD=arduino_101
$ make BOARD=arduino_101 flash
.. zephyr-app-commands::
:zephyr-app: samples/basic/blink_led
:board: arduino_101
:goals: build flash
:compact:
After flashing the image to the board, the user LED on the board should start to
blinking as discussed in overview

10
samples/basic/blinky/README.rst
View file

@ -29,11 +29,11 @@ Building and Running
This samples does not output anything to the console. It can be built and
flashed to a board as follows:
.. code-block:: console
$ cd samples/basic/blinky
$ make BOARD=arduino_101
$ make BOARD=arduino_101 flash
.. zephyr-app-commands::
:zephyr-app: samples/basic/blinky
:board: arduino_101
:goals: build flash
:compact:
After flashing the image to the board, the user LED on the board should start to
blink.

10
samples/basic/button/README.rst
View file

@ -41,11 +41,11 @@ Building and Running
This sample can be built for multiple boards, in this example we will build it
for the nucleo_f103rb board:
.. code-block:: console
$ cd samples/basic/button
$ make BOARD=nucleo_f103rb
.. zephyr-app-commands::
:zephyr-app: samples/basic/button
:board: nucleo_f103rb
:goals: build
:compact:
After startup, the program looks up a predefined GPIO device, and configures the
pin in input mode, enabling interrupt generation on falling edge. During each

25
samples/basic/disco/README.rst
View file

@ -63,21 +63,26 @@ The sample can be found here: :file:`samples/basic/disco`.
Nucleo F103RB
=============
.. code-block:: console
$ make BOARD=nucleo_f103rb
.. zephyr-app-commands::
:zephyr-app: samples/basic/disco
:board: nucleo_f103rb
:goals: build
:compact:
Nucleo F401RE
=============
.. code-block:: console
$ make BOARD=nucleo_f401re
.. zephyr-app-commands::
:zephyr-app: samples/basic/disco
:board: nucleo_f401re
:goals: build
:compact:
Arduino 101
============
.. code-block:: console
$ make BOARD=arduino_101
.. zephyr-app-commands::
:zephyr-app: samples/basic/disco
:board: arduino_101
:goals: build
:compact:

10
samples/basic/fade_led/README.rst
View file

@ -42,8 +42,8 @@ Building and Running
This sample can be built for multiple boards, in this example we will build it
for the arduino_101 board:
.. code-block:: console
$ cd samples/basic/fade_led
$ make BOARD=arduino_101
$ make BOARD=arduino_101 flash
.. zephyr-app-commands::
:zephyr-app: samples/basic/fade_led
:board: arduino_101
:goals: build flash
:compact:

10
samples/basic/rgb_led/README.rst
View file

@ -43,8 +43,8 @@ Building and Running
This samples does not output anything to the console. It can be built and
flashed to a board as follows:
.. code-block:: console
$ cd samples/basic/rgb_led
$ make BOARD=arduino_101
$ make BOARD=arduino_101 flash
.. zephyr-app-commands::
:zephyr-app: samples/basic/rgb_led
:board: arduino_101
:goals: build flash
:compact:

10
samples/basic/servo_motor/README.rst
View file

@ -36,8 +36,8 @@ Building and Running
This sample can be built for multiple boards, in this example we will build it
for the arduino_101 board:
.. code-block:: console
$ cd samples/basic/servo_motor
$ make BOARD=arduino_101
$ make BOARD=arduino_101 flash
.. zephyr-app-commands::
:zephyr-app: samples/basic/servo_motor
:board: arduino_101
:goals: build flash
:compact:

9
samples/basic/threads/README.rst
View file

@ -22,7 +22,8 @@ Each thread is then defined at compile time using K_THREAD_DEFINE.
Building
********
.. code-block:: console
$ cd samples/basic/threads
$ make
.. zephyr-app-commands::
:zephyr-app: samples/basic/threads
:board: 96b_carbon
:goals: build flash
:compact: