aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/README
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-04-05 17:26:43 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-04-06 23:11:58 +0100
commitd9b4c804be3345d7782942cba4e9d9a3fd0891d0 (patch)
tree192254cbfef7079f275a0991534500b2683cdbcc /documentation/README
parent9796cbbf4fdf2ae08d9d78192234eb7ff1811440 (diff)
downloadopenembedded-core-contrib-d9b4c804be3345d7782942cba4e9d9a3fd0891d0.tar.gz
README: Updated to remove the ADT manual and add the SDK manual.
(From yocto-docs rev: 61474479f84e2f611684db152e7682275f8f19c3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/README')
-rw-r--r--documentation/README10
1 files changed, 6 insertions, 4 deletions
diff --git a/documentation/README b/documentation/README
index d01678d4f4..a4e70a8721 100644
--- a/documentation/README
+++ b/documentation/README
@@ -34,14 +34,16 @@ Manual Organization
Folders exist for individual manuals as follows:
-* adt-manual - The Yocto Project Application Developer's Guide.
+* sdk-manual - The Yocto Project Software Development Kit (SDK) Developer's Guide.
* bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide
* dev-manual - The Yocto Project Development Manual
* kernel-dev - The Yocto Project Linux Kernel Development Manual
* ref-manual - The Yocto Project Reference Manual
* yocto-project-qs - The Yocto Project Quick Start
-* mega-manual - An aggregated manual comprised of all YP manuals and guides
+* mega-manual - The Yocto Project Mega-Manual, which is an aggregated manual comprised
+ of all YP manuals and guides
* profile-manual - The Yocto Project Profile and Tracing Manual
+* toaster-manual - The Toaster Manual
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
@@ -68,10 +70,10 @@ 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.
+creates an HTML version of the SDK manual.
The DOC variable specifies the manual you are making:
- $ make DOC=adt-manual
+ $ make DOC=sdk-manual
poky.ent
========