From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Wed, 15 Dec 2010 21:19:09 +0000 (-0800)
Subject: documentation/bsp-guide/bsp.xml:  Added the README section.
X-Git-Tag: 2011-1~3341
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e71027eaf2636dd94e4f09c86264589511f0ccd6;p=thirdparty%2Fopenembedded%2Fopenembedded-core.git

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---

diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 2a96b56f140..fcf10a6715a 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>