Author: ianmacarthur Date: 2011-01-10 03:37:22 -0800 (Mon, 10 Jan 2011) New Revision: 8238 Log: Attempt to update doxygen description of building under winXX as it was out of date
Modified: branches/branch-1.3/documentation/src/intro.dox Modified: branches/branch-1.3/documentation/src/intro.dox =================================================================== --- branches/branch-1.3/documentation/src/intro.dox 2011-01-10 11:35:47 UTC (rev 8237) +++ branches/branch-1.3/documentation/src/intro.dox 2011-01-10 11:37:22 UTC (rev 8238) @@ -123,9 +123,9 @@ \section intro_licensing Licensing FLTK comes with complete free source code. -FLTK is available under the terms of the +FLTK is available under the terms of the \ref license "GNU Library General Public License" -with exceptions that allow for static linking. +with exceptions that allow for static linking. Contrary to popular belief, it can be used in commercial software - even Bill Gates could use it! @@ -245,31 +245,97 @@ \section intro_windows Building FLTK Under Microsoft Windows -There are three ways to build FLTK under Microsoft Windows. -The first is to use one of the VisualC project files in the -"ide" directory. Just open (or double-click on) -the "fltk.dsw" or "fltk.sln" file to get the whole shebang. +NOTE: This documentation section is currently under review. +More up-to-date information for this release may be available +in the file README.MSWindows.txt and you should read +that file to determine if there are changes that may be +applicable to your build environment. -The second method is to use the \p configure script -included with the FLTK software; this has only been tested with -the Cygwin tools: +FLTK 1.3 is officially supported on Windows (2000,) 2003, +XP, and later. Older Windows versions prior to Windows 2000 +are not officially supported, but may still work. +The main reason is that the OS version needs to support UTF-8. +FLTK 1.3 is known to work on recent versions of +Windows such as Windows 7 and Vista and has been reported to work +in both 32-bit and 64-bit versions of these. +FLTK currently supports the following development +environments on the Windows platform: + +CAUTION: Libraries built by any one of these build +environments can not be mixed +with object files from any of the other environments! +(They use incompatible C++ conventions internally.) + +Free Microsoft Visual C++ 2008 Express and Visual +C++ 2010 Express using the supplied workspace and +project files. Older versions, and the commercial +versions, can be used as well, if they can open +the project files. +Be sure to get your service packs! + +The project files can be found in the ide/ directory. +Please read ide/README.IDE for more info about this. + + +GNU toolsets (Cygwin or MinGW) hosted on Windows. + +If using Cygwin with the Cygwin shell, or MinGW with +the Msys shell, these build environments behave very +much like a Unix or OSX build and the notes above in +the section on +Building and Installing FLTK Under UNIX and Apple OS X +apply, in particular the descriptions of using the +"configure" script and its related options. + +In general for a build using these tools, e.g. for +the Msys shell with MinGW, +it should suffice to "cd" into the directory where +you have extracted the fltk tarball and type: + \code -sh configure --prefix=C:/FLTK +./configure make \endcode -The final method is to use a GNU-based development tool with -the files in the "makefiles" directory. To build -using one of these tools simply copy the appropriate -makeinclude and config files to the main directory and do a -make: +This will build the fltk libraries and they can then be +utilised directly from the build location. +NOTE: this may be simpler than "installing" them in +many cases as different tool chains on Windows have +different ideas about where the files should be "installed" to. +For example, if you "install" the libraries using Msys/MinGW +with the following command: + \code -copy makefiles\Makefile.<env> Makefile +make install +\endcode + +Then Msys will "install" the libraries to where it thinks +the path "/usr/local/" leads to. If you only ever build code +from within the Msys environment this works well, but the +actual "Windows path" these files are located in will be +something like "C:\msys\1.0\local\lib", depending +on where your Msys installation is rooted, which may +not be useful to other tools. + +If you want to "install" your built fltk libraries in a +"non-standard" location you may do: + +\code +sh configure --prefix=C:/FLTK make \endcode +Where the value passed to "prefix" is the path at which +you would like fltk to be installed. + +A subsequent invocation of "make install" will then place +the fltk libraries and header files into that path. + +The other options to "configure" may also be used to +tailor the build to suit your environment. + \subsection intro_visualcpp Using the Visual C++ DLL Library The "fltkdll.dsp" project file builds a DLL-version @@ -289,7 +355,7 @@ \par WWW http://www.fltk.org/ <br> -http://www.fltk.org/str.php [for reporting bugs] <br> +http://www.fltk.org/str.php [for reporting bugs] <br> http://www.fltk.org/software.php [source code]<br> http://www.fltk.org/newsgroups.php [newsgroup/forums] @@ -304,9 +370,9 @@ http://fltk.org/newsgroups.php [web interface]<br> Point your NNTP news reader at news.easysw.com. At minimum, you'll want to subscribe -to the "fltk.general" group for general FLTK questions and answers. +to the "fltk.general" group for general FLTK questions and answers. -You can also use the web interface to the newsgroup; just go to the main http://fltk.org/ +You can also use the web interface to the newsgroup; just go to the main http://fltk.org/ page and click on "Forums". \section intro_reporting Reporting Bugs @@ -315,7 +381,7 @@ <A href="http://www.fltk.org/str.php";>http://www.fltk.org/str.php</A>, and click on "Submit Bug or Feature Request". -You'll be prompted for the FLTK version, operating system & version, +You'll be prompted for the FLTK version, operating system & version, and compiler that you are using. We will be unable to provide any kind of help without that basic information. _______________________________________________ fltk-commit mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-commit
