@@ -103,7 +103,7 @@ layer and from it build an image. Here is an example::
Some BSPs require or depend on additional layers beyond the BSP's root
layer in order to be functional. In this case, you need to specify these
-layers in the ``README`` "Dependencies" section of the BSP's root layer.
+layers in the ``README.md`` "Dependencies" section of the BSP's root layer.
Additionally, if any build instructions exist for the BSP, you must add
them to the "Dependencies" section.
@@ -171,7 +171,7 @@ section.
#. *Optionally Clone the meta-intel BSP Layer:* If your hardware is
based on current Intel CPUs and devices, you can leverage this BSP
layer. For details on the ``meta-intel`` BSP layer, see the layer's
- :yocto_git:`README </meta-intel/tree/README.md>` file.
+ :yocto_git:`README.md </meta-intel/tree/README.md>` file.
#. *Navigate to Your Source Directory:* Typically, you set up the
``meta-intel`` Git repository next to the other layers in your build.
@@ -274,7 +274,7 @@ individual BSPs could differ. ::
meta-bsp_root_name/
meta-bsp_root_name/bsp_license_file
- meta-bsp_root_name/README
+ meta-bsp_root_name/README.md
meta-bsp_root_name/README.sources
meta-bsp_root_name/binary/bootable_images
meta-bsp_root_name/conf/layer.conf
@@ -462,18 +462,18 @@ developer. For information on how to maintain license compliance, see
the ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`"
section in the Yocto Project Development Tasks Manual.
-README File
------------
+README.md File
+--------------
-You can find this file in the BSP Layer at::
+You can find this Markdown-format file in the BSP Layer at::
- meta-bsp_root_name/README
+ meta-bsp_root_name/README.md
This file provides information on how to boot the live images that are
-optionally included in the ``binary/`` directory. The ``README`` file
+optionally included in the ``binary/`` directory. The ``README.md`` file
also provides information needed for building the image.
-At a minimum, the ``README`` file must contain a list of dependencies,
+At a minimum, the ``README.md`` file must contain a list of dependencies,
such as the names of any other layers on which the BSP depends and the
name of the BSP maintainer with his or her contact information.
@@ -512,7 +512,7 @@ use these kernels and images to get a system running and quickly get
started on development tasks.
The exact types of binaries present are highly hardware-dependent. The
-:ref:`README <bsp-guide/bsp:readme file>` file should be present in the
+:ref:`README.md <bsp-guide/bsp:readme.md file>` file should be present in the
BSP Layer and it explains how to use the images with the target
hardware. Additionally, the
:ref:`README.sources <bsp-guide/bsp:readme.sources file>` file should be
@@ -890,13 +890,13 @@ The requirements for a released BSP that conform to the Yocto Project are:
file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer
as an example.
-- *README File:* You must include a ``README`` file in the
+- *README.md File:* You must include a ``README.md`` file in the
``meta-bsp_root_name`` directory. See the
:yocto_git:`README.md </meta-raspberrypi/tree/README.md>`
file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer
as an example.
- At a minimum, the ``README`` file should contain the following:
+ At a minimum, the ``README.md`` file should contain the following:
- A brief description of the target hardware.
@@ -943,7 +943,7 @@ The requirements for a released BSP that conform to the Yocto Project are:
machine configuration files define variations of machine
configurations that the BSP supports. If a BSP supports multiple
machine variations, you need to adequately describe each variation in
- the BSP ``README`` file. Do not use multiple machine configuration
+ the BSP ``README.md`` file. Do not use multiple machine configuration
files to describe disparate hardware. If you do have very different
targets, you should create separate BSP layers for each target.
Since the standard for BSP layers appears to be top-level "README.md" files rather than just "README" (and since some of the links are actually misnamed because of this), do a global replacement throughout the guide. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> ---