diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-02-29 10:26:12 -0600 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-03-08 12:08:05 -0800 |
| commit | 7aa91dd95847cca6b5f098522558a9e1a6c5874a (patch) | |
| tree | 5919f7285dda3efde6a291def120302c85c103a5 /documentation/README | |
| parent | 72a568425b3bc3cb772c04ac7e038464e5bc378c (diff) | |
| download | ast2050-yocto-poky-7aa91dd95847cca6b5f098522558a9e1a6c5874a.zip ast2050-yocto-poky-7aa91dd95847cca6b5f098522558a9e1a6c5874a.tar.gz | |
documentation/README: Created a README file
Initial file.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 37fea0686161333338ca79710e0bf75a67b14c5f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/README')
| -rw-r--r-- | documentation/README | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/documentation/README b/documentation/README new file mode 100644 index 0000000..5f41f79 --- /dev/null +++ b/documentation/README @@ -0,0 +1,52 @@ +documentation +============= + +This is the location for the Yocto Project documentation. Documentation +consists of six manuals (see below). + +Manual Organization +=================== + +Folders exist for individual manuals as follows: + +* adt-manual - The Yocto Project Application Development Toolkit (ADT) + User's Guide. +* bsp-guide - The Yocto Project Board Support (BSP) Developer's Guide +* dev-manual - The Yocto Project Development Manual +* kernel-manual - The Yocto Project Kernel Architecture and Use Manual +* poky-ref-manual - The Yocto Project Reference Manual +* yocto-project-qs - The Yocto Project Quick Start + +Each folder is self-contained regarding content and figures. + +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 ADT manual. +The DOC variable specifies the manual you are making: + + $ make DOC=adt-manual + +poky.ent +======== + +This file defines variables used for documentation production. The variables +are used to define release pathnames, URLs for the published manuals, etc. + +template +======== +Contains various templates, fonts, and some old PNG files. + +tools +===== +Contains a tool to convert the DocBook files to PDF format. + + + |
