From a177aad56d7857f4d81fae8b34a043ecf5505500 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 23 Aug 2012 13:08:01 -0700 Subject: documentation/README: Updates for mega-manual Added information about the mega-manual. (From yocto-docs rev: bbf75682f957ad2e124aa9476f52cd2bd3829fa6) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/README | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'documentation/README') diff --git a/documentation/README b/documentation/README index 2536d9ad9b..be51fb3a48 100644 --- a/documentation/README +++ b/documentation/README @@ -41,8 +41,13 @@ Folders exist for individual manuals as follows: * 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 +* mega-manual - The aggregated manual comprised of all YP manuals and guides -Each folder is self-contained regarding content and figures. +Each folder is self-contained regarding content and figures. Note that there +is a sed file needed to process the links of the mega-manual. The sed file +is located in the tools directory. Also note that the figures folder in the +mega-manual directory contains duplicates of all the figures in the YP folders +directories for all YP manuals and guides. Makefile ======== @@ -71,7 +76,10 @@ Contains various templates, fonts, and some old PNG files. tools ===== -Contains a tool to convert the DocBook files to PDF format. +Contains a tool to convert the DocBook files to PDF format. This folder also +contains the mega-manual.sed file, which is used by Makefile to process +cross-references from within the manual that normally go to an external +manual. -- cgit v1.2.3-54-g00ecf