From 7aa91dd95847cca6b5f098522558a9e1a6c5874a Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 29 Feb 2012 10:26:12 -0600 Subject: documentation/README: Created a README file Initial file. Reported-by: Robert P. J. Day (From yocto-docs rev: 37fea0686161333338ca79710e0bf75a67b14c5f) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/README | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 documentation/README (limited to 'documentation/README') diff --git a/documentation/README b/documentation/README new file mode 100644 index 0000000000..5f41f79c37 --- /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. + + + -- cgit v1.2.3-54-g00ecf