From 3b7918360a45802efdd0890dcf955a0b2901b0ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=AD=20Bol=C3=ADvar?= Date: Fri, 17 Apr 2020 11:16:39 -0700 Subject: [PATCH] doc: blinky: touch up README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The devicetree link is rendering as "Devicetree Guide" instead of "devicetree". Fix that. My guess is that most users won't care about the details of the requirements, and rather just want to know if their board is supported or not. So move the error you'll see on unsupported boards before the details about how to add support (which involve a pretty significant learning curve). Also mention overlays as a way to get this working. Signed-off-by: Martí Bolívar --- samples/basic/blinky/README.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/samples/basic/blinky/README.rst b/samples/basic/blinky/README.rst index 674ab1099e..d7c93445f8 100644 --- a/samples/basic/blinky/README.rst +++ b/samples/basic/blinky/README.rst @@ -16,17 +16,18 @@ and off. Requirements ************ -The board must have an LED connected via a GPIO pin. These are called "User -LEDs" on many of Zephyr's :ref:`boards`. The LED must be configured using the -``led0`` :ref:`dt-guide` alias in the :ref:`BOARD.dts file -`. - You will see this error if you try to build Blinky for an unsupported board: .. code-block:: none Unsupported board: led0 devicetree alias is not defined +The board must have an LED connected via a GPIO pin. These are called "User +LEDs" on many of Zephyr's :ref:`boards`. The LED must be configured using the +``led0`` :ref:`devicetree ` alias. This is usually done in the +:ref:`BOARD.dts file ` or a :ref:`devicetree overlay +`. + Building and Running ********************