summaryrefslogtreecommitdiffstats
path: root/documentation/README
Commit message (Collapse)AuthorAgeFilesLines
* documentation/README: Refer to top-level README for contributionsPaul Barker2020-11-201-0/+6
| | | | | | | | | | This may help anyone looking for patch contribution guidelines in the documentation directory itself. (From yocto-docs rev: 276740dd3780b0bdf04996efeed3c237fd26da1f) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Add Pipenv supportJoshua Watt2020-11-121-0/+7
| | | | | | | | | | Adds a Pipfile so that Pipenv can be used to automatically install all the dependencies required to build the documentation (From yocto-docs rev: 31658ad30827d38dcd4ea83bcfb828441c7c3eca) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: "yocto-project-qs" -> "brief-yoctoprojectqs"Robert P. J. Day2020-10-301-9/+9
| | | | | | | | | | Directory has been renamed, so fix README and add a bit more white space to keep everything lined up. (From yocto-docs rev: cdd4c705f7271e31e44a94c79b050eda1fba5945) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: rename Makefile.sphinxNicolas Dechesne2020-10-061-1/+1
| | | | | | | | | | Now that the DocBook files are removed, we can rename the top level Makefile. (From yocto-docs rev: 25fefa9a91ba5d7b398443f543e2c46165e8a3f4) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: include detailed information about sphinxNicolas Dechesne2020-09-291-28/+255
| | | | | | | | | | | * Updated the README to include instructions to build the doc with sphinx * Added design guidelines for new contributors (From yocto-docs rev: 7f64574f7594de22fbd29d9da9b8c9df4ba05ffb) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to change dev-manual titleScott Rifenbark2017-10-301-2/+2
| | | | | | | | | | | | Updated several files to change the title of the dev-manual from the "Yocto Project Development Manual" to the "Yocto Project Development Tasks Manual." Did some edits in the README and the Makefile as well for completeness. (From yocto-docs rev: 0278d6d3bb458af1cb04fbc3eed96dff12d19475) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: Updated to remove the ADT manual and add the SDK manual.Scott Rifenbark2016-04-061-4/+6
| | | | | | | (From yocto-docs rev: 61474479f84e2f611684db152e7682275f8f19c3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: Updated the file to reflect current state of documentationScott Rifenbark2013-08-131-34/+31
| | | | | | | | | | | This file was out of date. I replaced the kernel-manual descriptions with dev-kernel. Also, added the profiling manual. Finally, changed the poky-ref-manual string to ref-manual. (From yocto-docs rev: a1e60078dcfcfd5a912d78f981fe70dc1aa33e37) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: updated to include website information.Scott Rifenbark2012-09-241-0/+9
| | | | | | | (From yocto-docs rev: 439bd3c11e46d653234da928cfea6ab46666f0f2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: Updates for mega-manualScott Rifenbark2012-09-041-2/+10
| | | | | | | | | Added information about the mega-manual. (From yocto-docs rev: bbf75682f957ad2e124aa9476f52cd2bd3829fa6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: Updates to explain developmentScott Rifenbark2012-03-231-2/+27
| | | | | | | | | | | | | I added information that describes the relationship between poky/documentation and yocto-docs/documentation. For developers, they need to know to work from the yocto-docs Git repository and not to rely on the poky/documentation Git repository, which can lag behind the other one. (From yocto-docs rev: 0cbc781d3e9544c9920fdaf4548d882dd79b3d6c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: Created a README fileScott Rifenbark2012-03-081-0/+52
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>