summaryrefslogtreecommitdiff
path: root/documentation/README
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/README')
-rw-r--r--documentation/README15
1 files changed, 11 insertions, 4 deletions
diff --git a/documentation/README b/documentation/README
index f3ae94a70..1ee5204ec 100644
--- a/documentation/README
+++ b/documentation/README
@@ -1,10 +1,17 @@
README
------
-The documentation in this directory is in HTML format. To read it just
-point your browser at the "index.html" file. A slightly more browseable
-version is accessable at the FLTK web site, along with PostScript(tm)
-and PDF versions of the manual.
+The documentation in this directory is in PDF format.
+To read it, please open the fltk.pdf file in this directory
+
+To generate the doxygen HTML documention,
+you should have Doxygen version 1.5.5 min.
+
+To read it, please open the "html/index.html" file.
+A documentation version is also accessable at the FLTK web site,
+along with PostScript(tm) and PDF versions of the manual.
+
+*CHECK this and modify: (we currently use doxygen for doc generation) :
You can generate your own (printable) copy of the manual by typing
"make" in this directory. You will need to have the HTMLDOC software