1wxWidgets 2.8.12
2---------------------------------------------------------
3
4Welcome to wxWidgets, a sophisticated cross-platform C++
5framework for writing advanced GUI applications using
6native controls where possible.
7
8In addition to common and advanced GUI facilities such as
9frames, scrolling windows, toolbars, tree controls, icons,
10device contexts, printing, splitter windows and so on, there are
11wrappers for common file operations, and facilities for writing
12TCP/IP applications, thread handling, and more. Where certain
13features are not available on a platform, such as MDI and tree
14controls on Unix, they are emulated.
15
16A detailed 2000-page reference manual is supplied in HTML, PDF
17and Windows Help form: see the docs hierarchy.
18
19For a quick start, point your Web browser at docs/html/index.htm
20for a list of important documents and samples.
21
22Changes in this release
23-----------------------
24
25Please see changes.txt and "Changes since 2.6" in the manual
26for details.
27
28Platforms supported
29-------------------
30
31wxWidgets currently supports the following platforms:
32
33- Windows 95/98/ME, NT, 2000, XP, Vista, 7, Pocket PC/Mobile, Smartphone
34- Most Unix variants with GTK+ 1 and GTK+ 2
35- Most Unix variants with X11 (beta)
36- Most Unix variants with Motif/Lesstif
37- MacOS 9.x and 10.x using Carbon (10.3 and above preferred)
38- MacOS 10.x using Cocoa (beta)
39- OS/2 (beta)
40
41Most popular C++ compilers are supported; see the install.txt
42file for each platform (available via docs/html/index.htm) for details.
43See also http://www.wxwidgets.org/platform.htm.
44
45Note that 2.6 series were the last to fully support GTK+ 1.2, and Mac OS
469/Mac OS 10.2 and below. wxWidgets 2.7 and above focuses on GTK+ 2 and Mac OS
4710.3 and above and compatibility with earlier systems is not guaranteed any
48more.
49
50Files
51-----
52
53The distribution is available in archive formats appropriate to the
54target system. See the download pages for details.
55
56Installation
57------------
58
59wxWidgets needs to be compiled before you can test out the samples
60or write your own applications. For installation information, please
61see the install.txt file in the individual directories:
62
63  docs/msw
64  docs/gtk
65  docs/motif
66  docs/mac
67  docs/cocoa
68  docs/x11
69  docs/mgl
70  docs/os2
71  docs/palmos
72
73Licence information
74-------------------
75
76For licensing information, please see the files:
77
78  docs/preamble.txt
79  docs/licence.txt
80  docs/licendoc.txt
81  docs/gpl.txt
82  docs/lgpl.txt
83
84Although this may seem complex, it is there to allow authors of
85proprietary/commercial applications to use wxWidgets in addition
86to those writing GPL'ed applications. In summary, the licence is
87LGPL plus a clause allowing unrestricted distribution of
88application binaries. To answer a FAQ, you don't have to
89distribute any source if you wish to write commercial
90applications using wxWidgets.
91
92However, if you distribute wxGTK or wxMotif (with Lesstif)
93version of your application, don't forget that it is linked
94against GTK+ (or Lesstif) which is covered by LGPL *without*
95exception notice. Under Linux systems your app is probably linked
96against LGPL glibc as well. Please read carefully LGPL, section
976. which describes conditions for distribution of closed source
98applications linked against LGPL library. Basically you should
99link dynamically and include source code of LGPL libraries with
100your product (unless it is already present in user's system -
101like glibc usually is). If compiled with --enable-odbc (Unix
102only), wxWidgets library will contain iODBC library which is
103covered by LGPL.
104
105If you use TIFF image handler, please see src/tiff/COPYRIGHT
106for libtiff licence details.
107
108If you use JPEG image handler, documentation for your program
109should contain following sentence: "This software is based in
110part on the work of the Independent JPEG Group". See
111src/jpeg/README for details.
112
113If you use wxRegEx class on a system without native regular
114expressions support (i.e. MS Windows), see src/regex/COPYRIGHT
115file for Henry Spencer's regular expression library copyright.
116
117If you use wxXML classes or XRC, see src/expat/COPYING for licence details.
118
119Documentation
120-------------
121
122See docs/html/index.htm for an HTML index of the major documents.
123
124See docs/changes.txt for a summary of changes to wxWidgets.
125
126See docs/tech for an archive of technical notes.
127
128The wxWidgets bug tracker can be browsed at:
129
130    http://trac.wxwidgets.org/report
131
132Please use the search function of our Trac installation to find
133any possibly relevant bugs before reporting new ones. Also please
134notice that often trying to correct the bug yourself is the
135quickest way to fix it. Even if you fail to do it, you may
136discover valuable information allowing us to fix it while doing
137it. We also give much higher priority to bug reports with patches
138fixing the problems so this ensures that your report will be
139addressed sooner.
140
141The Windows HTML Help files are located in docs/htmlhelp.
142The Windows Help files are located in docs/winhelp.
143The PDF help files are located in docs/pdf.
144The HTB (wxWidgets HTML Help) files are located in docs/htb.
145
146Further information
147-------------------
148
149The wxWidgets Web site is located at:
150
151  http://www.wxwidgets.org
152
153The main wxWidgets ftp site is at:
154
155  ftp://biolpc22.york.ac.uk/pub
156
157Have fun!
158
159The wxWidgets Team, March 2011
160
161