documentation/README

   1 README (documentation)
   2 ----------------------
   3 FLTK 1.3 documentation is available in HTML and PDF format. The
   4 documentation must be generated in a separate step or downloaded
   5 from FLTK's software download pages. The documentation can also
   6 be accessed online.
   7
   8 To read the docs after downloading or generating them, open the
   9 files:
  10
  11     documentation/html/index.html
  12     documentation/fltk.pdf
  13
  14 with your browser or PDF viewer, respectively.
  15
  16
  17 Online Documentation:
  18 ---------------------
  19 A documentation version is available online at the FLTK web site,
  20 along with the PDF version of the manual. The docs on the web site
  21 are usually somewhat older (latest release). Use this URL to find
  22 the current online documentation:
  23
  24     http://www.fltk.org/documentation.php
  25
  26
  27 Documentation Download:
  28 -----------------------
  29 To download pre-generated docs, go to
  30
  31     http://www.fltk.org/software.php
  32
  33 and look for the files
  34
  35     fltk-<version>-docs-html.tar.gz
  36     fltk-<version>-docs-pdf.tar.gz
  37
  38 Extract the documentation tarballs into the same directory as you
  39 did with the source tarball.
  40
  41
  42 Generation of Documentation:
  43 ----------------------------
  44 To generate the documentation yourself, you should have Doxygen
  45 version 1.5.7 or later (recommended version is 1.7.3).
  46
  47 To generate the PDF version you also need a current version of LaTeX.
  48 You can use the packages tetex (older) or texlive (current) if your
  49 distribution provides them. You may need to install additional fonts
  50 and other sub-packages for the PDF version to be generated correctly.
  51
  52 Use "make html" in the documentation directory to generate the HTML
  53 documentation, or "make pdf" to generate the PDF version. "make dist"
  54 generates both versions in one step (as would do "make clean html pdf").
  55
  56 To read the HTML or PDF docs, see above.
  57
  58
  59 FLTK Developer Snapshots or Subversion Usage:
  60 ---------------------------------------------
  61 There is no pre-generated documentation available if you use a current
  62 developer snapshot or subversion. You must generate the documentation
  63 yourself.
  64
  65
  66 Bugs and Feature Requests:
  67 --------------------------
  68 If you find any typos, things that are unclear, or would like to
  69 contribute an example, section, or chapter to the FLTK manual, please
  70 post a question in the fltk newsgroup fltk.general or post a bug
  71 report or feature request at:
  72
  73     http://www.fltk.org/str.php