-wxWindows 2.1
--------------
+wxWidgets 2.8.1
+---------------------------------------------------------
+
+Welcome to wxWidgets, a sophisticated cross-platform C++
+framework for writing advanced GUI applications using
+native controls where possible.
+
+In addition to common and advanced GUI facilities such as
+frames, scrolling windows, toolbars, tree controls, icons,
+device contexts, printing, splitter windows and so on, there are
+wrappers for common file operations, and facilities for writing
+TCP/IP applications, thread handling, and more. Where certain
+features are not available on a platform, such as MDI and tree
+controls on Unix, they are emulated.
-Welcome to wxWindows 2, a sophisticated cross-platform C++
-framework for writing advanced GUI applications using (where
-possible) the native controls.
+A detailed 2000-page reference manual is supplied in HTML, PDF
+and Windows Help form: see the docs hierarchy.
-In addition to common and advanced GUI facilities such as frames, scrolling
-windows, toolbars, tree controls, icons, device contexts, printing,
-splitter windows and so on, there are wrappers for common file operations,
-and facilities for writing TCP/IP applications, thread handling, and more.
-Where certain features are not available on a platform, such as MDI and
-tree controls on Unix, they are emulated.
+For a quick start, point your Web browser at docs/html/index.htm
+for a list of important documents and samples.
-A detailed 1100-page reference manual is supplied in HTML, PDF and
-Windows Help form: see the docs hierarchy.
+Changes in this release
+-----------------------
-For a quick start, point your Web browser at docs/html/index.htm for a list of
-important documents and samples.
+Please see changes.txt and "Changes since 2.6" in the manual
+for details.
Platforms supported
-------------------
-wxWindows 2 currently supports the following platforms:
+wxWidgets currently supports the following platforms:
-- Windows 3.1, Windows 95/98, Windows NT
+- Windows 95/98/ME, NT, 2000, XP, Vista, Pocket PC/Mobile, Smartphone
+- Most Unix variants with GTK+ 1 and GTK+ 2
+- Most Unix variants with X11 (beta)
- Most Unix variants with Motif/Lesstif
-- Most Unix variants with GTK+
+- MacOS 9.x and 10.x using Carbon (10.3 and above preferred)
+- MacOS 10.x using Cocoa (beta)
+- OS/2 (beta)
+- PalmOS (alpha)
-Most popular C++ compilers are supported; see the release notes
-(available via docs/html/index.htm) for details.
+Most popular C++ compilers are supported; see the install.txt
+file for each platform (available via docs/html/index.htm) for details.
+See also http://www.wxwidgets.org/platform.htm.
+
+Note that 2.6 series were the last to fully support GTK+ 1.2, and Mac OS
+9/Mac OS 10.2 and below. wxWidgets 2.7 and above focuses on GTK+ 2 and Mac OS
+10.3 and above and compatibility with earlier systems is not guaranteed any
+more.
Files
-----
-The distribution is available in a number of formats.
-The most convenient is the platform-specific distribution,
-but the zip set forms a more complete distribution, for example if
-you wish to take part in wxWindows development. Also, add-ons
-such as OGL may only be available in zip form.
-
-Zip set
--------
-
-Depending on what you downloaded, you may have one or more of
-these ports. You may unarchive any or all of the ports into
-the same directory hierarchy. The zip archive set comprises the
-following:
-
-wx200gen.zip Generic source code and samples (required)
-wx200msw.zip Windows-specific source code
-wx200mot.zip Motif-specific source code
-wx200gtk.zip GTK-specific source code
-wx200stubs.zip Stubs ('empty port') source. Needs
- wx200gen.zip/tgz.
-wx200doc.zip Documentation source code (not required)
-wx200hlp.zip WinHelp documentation
-wx200pdf.zip Acrobat PDF documentation
-wx200htm.zip HTML documentation
-wx200vc.zip MS VC++ 5/6 project files
-wx200bc.zip Borland C++ 5 project files
-wx200cw.zip Metrowerks CodeWarrior 4.1 project files
-jpeg.zip Optional JPEG library
-ogl3.zip Optional Object Graphics Library
-glcanvas.zip Optional wxGLCanvas class (Motif, GTK, MSW)
-tex2rtf2.zip Tex2RTF documentation tool
-
-wxWindows for GTK distribution
-------------------------------
-
-TODO
-
-wxWindows for Motif distribution
---------------------------------
-
-TODO
-
-wxWindows for Windows distribution
-----------------------------------
-
-setup.exe Setup file (Windows 95/98, NT)
-setup.* Other setup files
+The distribution is available in archive formats appropriate to the
+target system. See the download pages for details.
Installation
------------
-wxWindows 2 needs to be compiled before you can test out
-the samples or write your own applications.
-For installation information, please see the install.txt file
-in the individual directories:
+wxWidgets needs to be compiled before you can test out the samples
+or write your own applications. For installation information, please
+see the install.txt file in the individual directories:
docs/msw
docs/gtk
docs/motif
+ docs/mac
+ docs/cocoa
+ docs/x11
+ docs/mgl
+ docs/os2
+ docs/palmos
Licence information
-------------------
docs/lgpl.txt
Although this may seem complex, it is there to allow authors of
-proprietary/commercial applications to use wxWindows in
-addition to those writing GPL'ed applications. In summary,
-the licence is L-GPL plus a clause allowing unrestricted
-distribution of application binaries. To answer a FAQ, you
-don't have to distribute any source if you wish to write
-commercial applications using wxWindows.
+proprietary/commercial applications to use wxWidgets in addition
+to those writing GPL'ed applications. In summary, the licence is
+LGPL plus a clause allowing unrestricted distribution of
+application binaries. To answer a FAQ, you don't have to
+distribute any source if you wish to write commercial
+applications using wxWidgets.
+
+However, if you distribute wxGTK or wxMotif (with Lesstif)
+version of your application, don't forget that it is linked
+against GTK+ (or Lesstif) which is covered by LGPL *without*
+exception notice. Under Linux systems your app is probably linked
+against LGPL glibc as well. Please read carefully LGPL, section
+6. which describes conditions for distribution of closed source
+applications linked against LGPL library. Basically you should
+link dynamically and include source code of LGPL libraries with
+your product (unless it is already present in user's system -
+like glibc usually is). If compiled with --enable-odbc (Unix
+only), wxWidgets library will contain iODBC library which is
+covered by LGPL.
+
+If you use TIFF image handler, please see src/tiff/COPYRIGHT
+for libtiff licence details.
+
+If you use JPEG image handler, documentation for your program
+should contain following sentence: "This software is based in
+part on the work of the Independent JPEG Group". See
+src/jpeg/README for details.
+
+If you use wxRegEx class on a system without native regular
+expressions support (i.e. MS Windows), see src/regex/COPYRIGHT
+file for Henry Spencer's regular expression library copyright.
+
+If you use wxXML classes or XRC, see src/expat/COPYING for licence details.
Documentation
-------------
-See docs/changes.txt for a history of changes to wxWindows 2.
See docs/html/index.htm for an HTML index of the major documents.
-The Windows help files are located in docs/winhelp.
+See docs/changes.txt for a summary of changes to wxWidgets.
+
+See docs/tech for an archive of technical notes.
+
+The wxWidgets bug database can be browsed at:
+
+ http://sourceforge.net/bugs/?group_id=9863
+
+The Windows HTML Help files are located in docs/htmlhelp.
+The Windows Help files are located in docs/winhelp.
The PDF help files are located in docs/pdf.
+The HTB (wxWidgets HTML Help) files are located in docs/htb.
Further information
-------------------
-The wxWindows Web site is located at:
-
- http://www.wxwindows.org
-
-The wxGTK Web site (with further wxGTK-specific files and
-information) is located at:
+The wxWidgets Web site is located at:
- http://www.freiburg.linux.de/~wxxt
+ http://www.wxwidgets.org
-The main wxWindows ftp site is at:
+The main wxWidgets ftp site is at:
- ftp://www.remstar.com/pub/wxwin
+ ftp://biolpc22.york.ac.uk/pub
-A wxWindows CD-ROM with the latest distribution plus an HTML
+A wxWidgets CD-ROM with the latest distribution plus an HTML
front-end and hundreds of MB of compilers, utilities and other
-material may be ordered from the CD-ROM page (see the wxWindows
-web site) or contact Julian Smart <julian.smart@ukonline.co.uk>.
+material may be ordered from the CD-ROM page: see the wxWidgets
+web site.
-Good luck!
+Have fun!
-The wxWindows Team, November 1999
+The wxWidgets Team, January 2007