doc: Add clarifications for doxygen generated documentation
authorlottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Tue, 4 Jan 2011 22:03:08 +0000 (22:03 +0000)
committerlottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Tue, 4 Jan 2011 22:03:08 +0000 (22:03 +0000)
git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4666 38d2e660-2303-0410-9eaa-f027e97ec537

README

diff --git a/README b/README
index 68b5489c01a1cfb00764ddd6f557ed3d596da7ca..50256eea5d552b5681ba640cb26a66a318cf57c3 100644 (file)
--- 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