README 6.7 KB

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