summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/README
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2015-09-15 14:41:29 -0500
committerPatrick Williams <patrick@stwcx.xyz>2015-09-15 14:41:29 -0500
commitc124f4f2e04dca16a428a76c89677328bc7bf908 (patch)
treecc1bfbbced5244130a102cdd63c72584b1d6e408 /bitbake/doc/README
downloadblackbird-openbmc-c124f4f2e04dca16a428a76c89677328bc7bf908.tar.gz
blackbird-openbmc-c124f4f2e04dca16a428a76c89677328bc7bf908.zip
Squashed 'yocto-poky/' content from commit ea562de
git-subtree-dir: yocto-poky git-subtree-split: ea562de57590c966cd5a75fda8defecd397e6436
Diffstat (limited to 'bitbake/doc/README')
-rw-r--r--bitbake/doc/README39
1 files changed, 39 insertions, 0 deletions
diff --git a/bitbake/doc/README b/bitbake/doc/README
new file mode 100644
index 000000000..303cf8eec
--- /dev/null
+++ b/bitbake/doc/README
@@ -0,0 +1,39 @@
+Documentation
+=============
+
+This is the directory that contains the BitBake documentation.
+
+Manual Organization
+===================
+
+Folders exist for individual manuals as follows:
+
+* bitbake-user-manual - The BitBake User Manual
+
+Each folder is self-contained regarding content and figures.
+
+If you want to find HTML versions of the BitBake manuals on the web,
+go to http://www.openembedded.org/wiki/Documentation.
+
+Makefile
+========
+
+The Makefile processes manual directories to create HTML, PDF,
+tarballs, etc. Details on how the Makefile work are documented
+inside the Makefile. See that file for more information.
+
+To build a manual, you run the make command and pass it the name
+of the folder containing the manual's contents.
+For example, the following command run from the documentation directory
+creates an HTML and a PDF version of the BitBake User Manual.
+The DOC variable specifies the manual you are making:
+
+ $ make DOC=bitbake-user-manual
+
+template
+========
+Contains various templates, fonts, and some old PNG files.
+
+tools
+=====
+Contains a tool to convert the DocBook files to PDF format.
OpenPOWER on IntegriCloud