mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
fd13aabd19
fltk/documentation
History
Fabien Costantini fd13aabd19 Enabled Xcode docset makefile generation as it is transparent for non xcode users. 
More precisely this option only adds a new hmtl/Makefile target and will permit 
to make and install fltk doc to be incorporated to XCode 3, 
but it is not automatically generated, even on the mac platform; 
as you still have to run manually make install from the html directory to activate that one. 
Works Great, FLTK documentation side by side with Apple Documentation in your XCode environment !!!



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6457 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-18 16:23:26 +00:00
..
src Moved latex related files to src, man files to src, updated Makefile and Doxyfile accordingly. 2008-10-17 12:42:28 +00:00
Doxyfile Enabled Xcode docset makefile generation as it is transparent for non xcode users. 2008-10-18 16:23:26 +00:00
Makefile Documentation makefile: Fixed make install would return an error if html folder does not exist. 2008-10-17 20:46:27 +00:00
README Doxygen documentation:updated README 2008-10-18 07:52:26 +00:00
TODO.doc Changed the former todo_filelist used for WPs about porting old html to doxygen to a general TODO.doc now. 2008-10-17 12:50:16 +00:00

README 

README
------

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.

You can generate your own (printable) copy of the manual by typing
"make pdf" in this directory.  

For future book gen alternative (TODO or CHECK):
You will need to have the HTMLDOC software
installed on your system.  HTMLDOC can be downloaded from:
    http://www.easysw.com/htmldoc

The default media size is 8.27x11.0" (210x279mm), which is the lesser
of A4 and US Letter sizes.  You can change this in the makefile by
uncommenting the corresponding media size or defining your own.

If you find any typos, things that are unclear, or would like to
contribute an example, section, or chapter to the FLTK manual, please
contact Michael Sweet (mike@easysw.com).