From: lottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Tue, 4 Jan 2011 22:03:08 +0000 (+0000)
Subject: doc: Add clarifications for doxygen generated documentation
X-Git-Tag: 2.7.0~300
X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=914d22d8571b2863ced899eb74f2c51c4449f7db;p=bertos.git

doc: Add clarifications for doxygen generated documentation

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4666 38d2e660-2303-0410-9eaa-f027e97ec537
---

diff --git a/README b/README
index 68b5489c..50256eea 100644
--- a/README
+++ b/README
@@ -2,6 +2,8 @@ This is the source code of BeRTOS operating system.
 
 You can generate the documentation using doxygen with the file Doxyfile-offline:
 $ doxygen Doxyfile-offline
+You can read the generated documentation by opening the file
+doc/offline-reference/html/index.html
 
 You can read the latest documentation online at the following address:
 http://dev.bertos.org/doxygen