From 7a2f4425cf9c83ac32c2cfcc2620ecb7045d1fdc Mon Sep 17 00:00:00 2001 From: Tobias Schuele Date: Wed, 11 Feb 2015 13:18:31 +0100 Subject: [PATCH] Modified paragraph on documentation in README.md --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index acb7b43..6669a48 100644 --- a/README.md +++ b/README.md @@ -284,9 +284,13 @@ The C header files can be included as follows: Documentation ------------- -EMB² comes with a tutorial, example programs, and an HTML reference -documentation describing the APIs, which can be found in the "doc" folder. -The root document of the HTML reference is "doc/reference/index.html". +The release files of EMB² come with a tutorial, example programs, and a +reference manual (HTML) describing the APIs. All documentation is contained in +the "doc" folder. The root document of the HTML reference is +"doc/reference/index.html". Note that generated documentation files are not +under version control and hence not contained in the repository. As mentioned +above, it is therefore recommended to download one of the packaged release +files in order to have ready-to-use documentation. Code Quality -- libgit2 0.26.0