documentation/bsp-guide/bsp.xml: Added the README section.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
This commit is contained in:
Scott Rifenbark 2010-12-15 13:19:09 -08:00 committed by Richard Purdie
parent 0ab1b2c31c
commit e71027eaf2
1 changed files with 19 additions and 0 deletions

View File

@ -137,6 +137,25 @@ meta-&lt;bsp_name&gt;/&lt;bsp_license_file&gt;
</para>
</section>
<section id="bsp-filelayout-readme">
<title>README File</title>
<programlisting>
meta-&lt;bsp_name&gt;/README
</programlisting>
<para>
This file provides information on how to boot the live images that are optionally
included in the <filename>/binary</filename> directory.
The <filename>README</filename> file also provides special information needed for
building the image.
</para>
<para>
Technically speaking a <filename>README</filename> is optional but it is highly
recommended that every BSP has one.
</para>
</section>
<section id="bsp-filelayout-binary">
<title>Pre-built User Binaries (meta-&lt;bsp_name&gt;/binary/*)</title>