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