diff options
-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 0000000000..5f41f79c37 --- /dev/null +++ b/documentation/README | |||
@@ -0,0 +1,52 @@ | |||
1 | documentation | ||
2 | ============= | ||
3 | |||
4 | This is the location for the Yocto Project documentation. Documentation | ||
5 | consists of six manuals (see below). | ||
6 | |||
7 | Manual Organization | ||
8 | =================== | ||
9 | |||
10 | Folders exist for individual manuals as follows: | ||
11 | |||
12 | * adt-manual - The Yocto Project Application Development Toolkit (ADT) | ||
13 | User's Guide. | ||
14 | * bsp-guide - The Yocto Project Board Support (BSP) Developer's Guide | ||
15 | * dev-manual - The Yocto Project Development Manual | ||
16 | * kernel-manual - The Yocto Project Kernel Architecture and Use Manual | ||
17 | * poky-ref-manual - The Yocto Project Reference Manual | ||
18 | * yocto-project-qs - The Yocto Project Quick Start | ||
19 | |||
20 | Each folder is self-contained regarding content and figures. | ||
21 | |||
22 | Makefile | ||
23 | ======== | ||
24 | |||
25 | The Makefile processes manual directories to create HTML, PDF, | ||
26 | tarballs, etc. Details on how the Makefile work are documented | ||
27 | inside the Makefile. See that file for more information. | ||
28 | |||
29 | To build a manual, you run the make command and pass it the name | ||
30 | of the folder containing the manual's contents. | ||
31 | For example, the following command run from the documentation directory | ||
32 | creates an HTML and a PDF version of the ADT manual. | ||
33 | The DOC variable specifies the manual you are making: | ||
34 | |||
35 | $ make DOC=adt-manual | ||
36 | |||
37 | poky.ent | ||
38 | ======== | ||
39 | |||
40 | This file defines variables used for documentation production. The variables | ||
41 | are used to define release pathnames, URLs for the published manuals, etc. | ||
42 | |||
43 | template | ||
44 | ======== | ||
45 | Contains various templates, fonts, and some old PNG files. | ||
46 | |||
47 | tools | ||
48 | ===== | ||
49 | Contains a tool to convert the DocBook files to PDF format. | ||
50 | |||
51 | |||
52 | |||