diff options
| -rw-r--r-- | documentation/README | 29 |
1 files changed, 27 insertions, 2 deletions
diff --git a/documentation/README b/documentation/README index 5f41f79c37..2536d9ad9b 100644 --- a/documentation/README +++ b/documentation/README | |||
| @@ -1,8 +1,33 @@ | |||
| 1 | documentation | 1 | documentation |
| 2 | ============= | 2 | ============= |
| 3 | 3 | ||
| 4 | This is the location for the Yocto Project documentation. Documentation | 4 | This is the directory that contains the Yocto Project documentation. The Yocto |
| 5 | consists of six manuals (see below). | 5 | Project source repositories at http://git.yoctoproject.org/cgit.cgi have two |
| 6 | instances of the "documentation" directory. You should understand each of | ||
| 7 | these instances. | ||
| 8 | |||
| 9 | poky/documentation - The directory within the poky Git repository containing | ||
| 10 | the set of Yocto Project manuals. When you clone the | ||
| 11 | poky Git repository, the documentation directory | ||
| 12 | contains the manuals. The state of the manuals in this | ||
| 13 | directory is guaranteed to reflect the latest Yocto | ||
| 14 | Project release. The manuals at the tip of this | ||
| 15 | directory will also likely contain most manual | ||
| 16 | development changes. | ||
| 17 | |||
| 18 | yocto-docs/documentation - The Git repository for the Yocto Project manuals. | ||
| 19 | This repository is where manual development | ||
| 20 | occurs. If you plan on contributing back to the | ||
| 21 | Yocto Project documentation, you should set up | ||
| 22 | a local Git repository based on this upstream | ||
| 23 | repository as follows: | ||
| 24 | |||
| 25 | git clone git://git.yoctoproject.org/yocto-docs | ||
| 26 | |||
| 27 | Changes and patches are first pushed to the | ||
| 28 | yocto-docs Git repository. Later, they make it | ||
| 29 | into the poky Git repository found at | ||
| 30 | git://git.yoctoproject.org/poky. | ||
| 6 | 31 | ||
| 7 | Manual Organization | 32 | Manual Organization |
| 8 | =================== | 33 | =================== |
