summaryrefslogtreecommitdiffstats
path: root/documentation/README
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-02-29 16:26:12 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 20:08:05 (GMT)
commit7aa91dd95847cca6b5f098522558a9e1a6c5874a (patch)
tree5919f7285dda3efde6a291def120302c85c103a5 /documentation/README
parent72a568425b3bc3cb772c04ac7e038464e5bc378c (diff)
downloadpoky-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/README52
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 @@
1documentation
2=============
3
4This is the location for the Yocto Project documentation. Documentation
5consists of six manuals (see below).
6
7Manual Organization
8===================
9
10Folders 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
20Each folder is self-contained regarding content and figures.
21
22Makefile
23========
24
25The Makefile processes manual directories to create HTML, PDF,
26tarballs, etc. Details on how the Makefile work are documented
27inside the Makefile. See that file for more information.
28
29To build a manual, you run the make command and pass it the name
30of the folder containing the manual's contents.
31For example, the following command run from the documentation directory
32creates an HTML and a PDF version of the ADT manual.
33The DOC variable specifies the manual you are making:
34
35 $ make DOC=adt-manual
36
37poky.ent
38========
39
40This file defines variables used for documentation production. The variables
41are used to define release pathnames, URLs for the published manuals, etc.
42
43template
44========
45Contains various templates, fonts, and some old PNG files.
46
47tools
48=====
49Contains a tool to convert the DocBook files to PDF format.
50
51
52