README

   1 README - Fast Light Tool Kit (FLTK) Version 1.3.0
   2 -------------------------------------------------
   3
   4 WHAT IS FLTK?
   5
   6     The Fast Light Tool Kit ("FLTK", pronounced "fulltick") is a
   7     a cross-platform C++ GUI toolkit for UNIX(r)/Linux(r) (X11),
   8     Microsoft(r) Windows(r), and MacOS(r) X. FLTK provides
   9     modern GUI functionality without the bloat and supports 3D
  10     graphics via OpenGL(r) and its built-in GLUT emulation. It
  11     was originally developed by Mr. Bill Spitzak and is
  12     currently maintained by a small group of developers across
  13     the world with a central repository in the US.
  14
  15
  16 LICENSING
  17
  18     FLTK comes with complete free source code. FLTK is available
  19     under the terms of the GNU Library General Public License.
  20     Contrary to popular belief, it can be used in commercial
  21     software! (Even Bill Gates could use it.)
  22
  23
  24 ON-LINE DOCUMENTATION
  25
  26     All of the documentation is in HTML in the subdirectory
  27     "documentation". The "index.html" file should be your
  28     starting point.  PostScript(tm) and PDF versions of this
  29     documentation is also available from the FLTK web site at:
  30
  31         http://www.fltk.org/documentation.php
  32
  33
  34 BUILDING AND INSTALLING FLTK UNDER UNIX AND Mac OS X
  35
  36     In most cases you can just type "make".  This will run
  37     configure with the default (no) options and then compile
  38     everything.
  39
  40     FLTK uses GNU autoconf to configure itself for your UNIX
  41     platform. The main things that the configure script will
  42     look for are the X11, OpenGL (or Mesa), and JPEG header and
  43     library files.  Make sure that they are in the standard
  44     include/library locations.  If they aren't you need to
  45     define the CFLAGS, CXXFLAGS, and LDFLAGS environment
  46     variables.
  47
  48     If you aren't using "gcc", "g++", "c++", or "CC" for your
  49     C++ compiler, you'll also need to set the CXX environment
  50     variable. Similarly, if you aren't using "gcc" or "cc" for
  51     your C compiler you'll need to set the CC environment
  52     variable.
  53
  54     You can run configure yourself to get the exact setup you
  55     need. Type "./configure <options>".  Options include:
  56
  57         --enable-cygwin         - Enable the Cygwin libraries (WIN32)
  58         --enable-debug          - Enable debugging code & symbols
  59         --disable-gl            - Disable OpenGL support
  60         --enable-shared         - Enable generation of shared libraries
  61         --enable-threads        - Enable multithreading support
  62         --enable-xdbe           - Enable the X double-buffer extension
  63         --enable-xft            - Enable the Xft library (anti-aliased fonts)
  64
  65         --bindir=/path          - Set the location for executables
  66                                   [default = /usr/local/bin]
  67         --libdir=/path          - Set the location for libraries
  68                                   [default = /usr/local/lib]
  69         --includedir=/path      - Set the location for include files.
  70                                   [default = /usr/local/include]
  71         --prefix=/dir           - Set the directory prefix for files
  72                                   [default = /usr/local]
  73
  74     When the configure script is done you can just run the
  75     "make" command. This will build the library, FLUID tool, and
  76     all of the test programs.
  77
  78     To install the library, become root and type "make
  79     install".  This will copy the "fluid" executable to
  80     "bindir", the header files to "includedir", and the library
  81     files to "libdir".
  82
  83     To install additional files and icons to be used by the main
  84     desktop environments such as KDE, GNOME and XFCE, you will also
  85     need to run "make install-desktop" as root.
  86
  87
  88 BUILDING FLTK UNDER MICROSOFT WINDOWS
  89
  90     There are two ways to build FLTK under Microsoft Windows.
  91     The first is to use the Visual C++ project files under the
  92     "ide/" directory.  See the file ide/README.IDE for more info.
  93
  94     The second method is to use a GNU-based development tool.
  95     To build with the Cygwin or MinGW tools, use the supplied
  96     configure script as specified in the UNIX section above:
  97
  98         sh configure ...options...
  99
 100
 101 INTERNET RESOURCES
 102
 103     FLTK is available on the 'net in a bunch of locations:
 104
 105         - WWW:   http://www.fltk.org/
 106                  http://www.fltk.org/str.php [for reporting bugs]
 107                  http://www.fltk.org/software.php [source code]
 108
 109         - FTP:   http://ftp.easysw.com/pub/fltk
 110                  ftp://ftp.easysw.com/pub/fltk
 111                  ftp://ftp2.easysw.com/pub/fltk
 112                  ftp://ftp.funet.fi/pub/mirrors/ftp.easysw.com/pub/fltk
 113                  ftp://linux.mathematik.tu-darmstadt.de/pub/linux/mirrors/misc/fltk
 114                  ftp://gd.tuwien.ac.at/hci/fltk
 115
 116         - EMail: fltk@fltk.org [see instructions below]
 117
 118     To send a message to the FLTK mailing list ("fltk@fltk.org")
 119     you must first join the list.  Non-member submissions are
 120     blocked to avoid problems with SPAM.
 121
 122     To join the FLTK mailing list, go the following web page:
 123
 124         http://lists.easysw.com/listinfo/fltk
 125
 126
 127 REPORTING BUGS
 128
 129     To report a bug in FLTK, use the form at:
 130
 131         http://www.fltk.org/str.php
 132
 133     For general support and questions, please use the FLTK
 134     mailing list at "fltk@fltk.org".
 135
 136
 137 TRADEMARKS
 138
 139     Microsoft and Windows are registered trademarks of Microsoft
 140     Corporation. UNIX is a registered trademark of the X/Open
 141     Group, Inc.  OpenGL is a registered trademark of Silicon
 142     Graphics, Inc.  Mac OS is a registered trademark of Apple
 143     Computers, Inc.
 144
 145
 146 COPYRIGHT
 147
 148     FLTK is copyright 1998-2011 by Bill Spitzak
 149     (spitzak@users.sourceforge.net) and others,
 150     see the CREDITS file for more info.
 151
 152     This library is free software; you can redistribute it
 153     and/or modify it under the terms of the GNU Library General
 154     Public License as published by the Free Software Foundation;
 155     either version 2 of the License, or (at your option) any
 156     later version.
 157
 158     This library is distributed in the hope that it will be
 159     useful, but WITHOUT ANY WARRANTY; without even the implied
 160     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 161     PURPOSE.  See the GNU Library General Public License for
 162     more details.
 163
 164     You should have received a copy of the GNU Library General
 165     Public License along with this library; if not, write to the
 166     Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 167     Boston, MA 02111-1307 USA.