summaryrefslogtreecommitdiffstats
path: root/documentation/bsp-guide/bsp.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/bsp-guide/bsp.xml')
-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-<bsp_name>/<bsp_license_file>
137 </para> 137 </para>
138 </section> 138 </section>
139 139
140 <section id="bsp-filelayout-readme">
141 <title>README File</title>
142 <programlisting>
143meta-&lt;bsp_name&gt;/README
144 </programlisting>
145
146 <para>
147 This file provides information on how to boot the live images that are optionally
148 included in the <filename>/binary</filename> directory.
149 The <filename>README</filename> file also provides special information needed for
150 building the image.
151 </para>
152
153 <para>
154 Technically speaking a <filename>README</filename> is optional but it is highly
155 recommended that every BSP has one.
156 </para>
157 </section>
158
140 <section id="bsp-filelayout-binary"> 159 <section id="bsp-filelayout-binary">
141 <title>Pre-built User Binaries (meta-&lt;bsp_name&gt;/binary/*)</title> 160 <title>Pre-built User Binaries (meta-&lt;bsp_name&gt;/binary/*)</title>
142 161