summaryrefslogtreecommitdiff
path: root/documentation/README
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-10-15 15:58:04 +0000
committerFabien Costantini <fabien@onepost.net>2008-10-15 15:58:04 +0000
commit14ca02ffff5b35ece05a1d7b71edd19a6a35d0be (patch)
tree47ab6b19cb168df9c122c7f6743b33f3c0bbc5af /documentation/README
parent5a71578b1b5a051fe7791e50a156333683a6806c (diff)
Doxygen documentation: commented out the 1.5.7 specific doc options, updated README for pdf and html use. Now minimum version required is 1.5.5
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6440 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
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