aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/bsp-guide
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2010-12-15 13:19:09 -0800
committerRichard Purdie <rpurdie@linux.intel.com>2010-12-21 12:49:43 +0000
commite71027eaf2636dd94e4f09c86264589511f0ccd6 (patch)
treeb616da97da4404259622b5a8a7630cde5a1147d7 /documentation/bsp-guide
parent0ab1b2c31c4899e8d9c641584e48e35acc544b8c (diff)
downloadpoky-e71027eaf2636dd94e4f09c86264589511f0ccd6.tar.gz
poky-e71027eaf2636dd94e4f09c86264589511f0ccd6.tar.bz2
poky-e71027eaf2636dd94e4f09c86264589511f0ccd6.zip
documentation/bsp-guide/bsp.xml: Added the README section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Diffstat (limited to 'documentation/bsp-guide')
-rw-r--r--documentation/bsp-guide/bsp.xml19
1 files changed, 19 insertions, 0 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 2a96b56f14..fcf10a6715 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -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>