summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/README
diff options
context:
space:
mode:
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 0000000..303cf8e
--- /dev/null
+++ b/bitbake/doc/README
@@ -0,0 +1,39 @@
1Documentation
2=============
3
4This is the directory that contains the BitBake documentation.
5
6Manual Organization
7===================
8
9Folders exist for individual manuals as follows:
10
11* bitbake-user-manual - The BitBake User Manual
12
13Each folder is self-contained regarding content and figures.
14
15If you want to find HTML versions of the BitBake manuals on the web,
16go to http://www.openembedded.org/wiki/Documentation.
17
18Makefile
19========
20
21The Makefile processes manual directories to create HTML, PDF,
22tarballs, etc. Details on how the Makefile work are documented
23inside the Makefile. See that file for more information.
24
25To build a manual, you run the make command and pass it the name
26of the folder containing the manual's contents.
27For example, the following command run from the documentation directory
28creates an HTML and a PDF version of the BitBake User Manual.
29The DOC variable specifies the manual you are making:
30
31 $ make DOC=bitbake-user-manual
32
33template
34========
35Contains various templates, fonts, and some old PNG files.
36
37tools
38=====
39Contains a tool to convert the DocBook files to PDF format.