]> git.saurik.com Git - wxWidgets.git/blame - docs/readme.txt
fix typo (see #10637)
[wxWidgets.git] / docs / readme.txt
CommitLineData
6865660d 1wxWidgets 2.9.x
5147354c 2---------------------------------------------------------
41c09d48 3
68a9f952
RR
4Welcome to wxWidgets, a cross-platform C++ framework for
5writing advanced GUI applications using native controls
6where possible.
2dc5505e 7
940718f0
JS
8In addition to common and advanced GUI facilities such as
9frames, scrolling windows, toolbars, tree controls, icons,
68a9f952
RR
10device contexts, printing, splitter windows and so on, there
11are wrappers for common file operations, and facilities for
12writing TCP/IP applications, thread handling, and more.
2dc5505e 13
68a9f952
RR
14Where certain features are not available on a platform, such
15as MDI under Unix and OS X, they are emulated.
41c09d48 16
68a9f952
RR
17A detailed reference manual including in-depth overviews for
18various topics is supplied in various formats and can be
19accessed online.
7921cf2b 20
ee1aaf99
JS
21Changes in this release
22-----------------------
23
6865660d 24Please see changes.txt and "Changes since 2.8" in the manual
5147354c 25for details.
ee1aaf99 26
41c09d48 27Platforms supported
c801d85f
KB
28-------------------
29
fc2171bd 30wxWidgets currently supports the following platforms:
41c09d48 31
b45ab290 32- Windows 95/98/ME, NT, 2000, XP, Vista, Pocket PC/Mobile, Smartphone
2a00b847
RR
33- Most Unix variants using the GTK+ 2 toolkit (version 2.4 or newer)
34- MacOS OS X (10.4 or newer) using Carbon and some Cocao mix-in
68a9f952
RR
35
36There is some support for the followig platforms:
37
38- Most Unix variants with X11
c4077b34 39- Most Unix variants with Motif/Lesstif
68a9f952
RR
40- Most Unix variants with GTK+ 1.2
41- MacOS 10.x using the Cocoa API
42- OS/2
43- PalmOS
8870c26e 44
9bb3479c
JS
45Most popular C++ compilers are supported; see the install.txt
46file for each platform (available via docs/html/index.htm) for details.
fc2171bd 47See also http://www.wxwidgets.org/platform.htm.
41c09d48
JS
48
49Files
50-----
51
f6bcfd97 52The distribution is available in archive formats appropriate to the
8dfe337a 53target system. See the download pages for details.
0bc9b25e 54
41c09d48
JS
55Installation
56------------
57
2a3476f2
JS
58wxWidgets needs to be compiled before you can test out the samples
59or write your own applications. For installation information, please
60see the install.txt file in the individual directories:
38d24a39
JS
61
62 docs/msw
63 docs/gtk
64 docs/motif
68a9f952 65 docs/osx
2a3476f2 66 docs/cocoa
2c7b88e6
JS
67 docs/x11
68 docs/mgl
4e3ad7c0 69 docs/os2
5147354c 70 docs/palmos
c801d85f 71
2dc5505e 72Licence information
41c09d48
JS
73-------------------
74
75For licensing information, please see the files:
76
77 docs/preamble.txt
78 docs/licence.txt
79 docs/licendoc.txt
80 docs/gpl.txt
81 docs/lgpl.txt
82
2dc5505e 83Although this may seem complex, it is there to allow authors of
5147354c
JS
84proprietary/commercial applications to use wxWidgets in addition
85to those writing GPL'ed applications. In summary, the licence is
86LGPL plus a clause allowing unrestricted distribution of
87application binaries. To answer a FAQ, you don't have to
88distribute any source if you wish to write commercial
89applications using wxWidgets.
90
91However, if you distribute wxGTK or wxMotif (with Lesstif)
92version of your application, don't forget that it is linked
93against GTK+ (or Lesstif) which is covered by LGPL *without*
94exception notice. Under Linux systems your app is probably linked
95against LGPL glibc as well. Please read carefully LGPL, section
966. which describes conditions for distribution of closed source
97applications linked against LGPL library. Basically you should
98link dynamically and include source code of LGPL libraries with
99your product (unless it is already present in user's system -
68a9f952 100like glibc usually is).
9922de0b 101
26de8b7d 102If you use TIFF image handler, please see src/tiff/COPYRIGHT
cb128243 103for libtiff licence details.
26de8b7d 104
5147354c
JS
105If you use JPEG image handler, documentation for your program
106should contain following sentence: "This software is based in
107part on the work of the Independent JPEG Group". See
108src/jpeg/README for details.
26de8b7d 109
5147354c
JS
110If you use wxRegEx class on a system without native regular
111expressions support (i.e. MS Windows), see src/regex/COPYRIGHT
112file for Henry Spencer's regular expression library copyright.
a553cb8b 113
cb128243
VS
114If you use wxXML classes or XRC, see src/expat/COPYING for licence details.
115
2dc5505e
JS
116Documentation
117-------------
118
2dc5505e
JS
119See docs/html/index.htm for an HTML index of the major documents.
120
2a3476f2 121See docs/changes.txt for a summary of changes to wxWidgets.
9ba09ba5
JS
122
123See docs/tech for an archive of technical notes.
6adaedf0 124
e5795ba9
VZ
125The wxWidgets bug tracker can be browsed at:
126
127 http://trac.wxwidgets.org/report
128
129Please use the search function of our Trac installation to find
130any possibly relevant bugs before reporting new ones. Also please
d7006f44
VZ
131notice that often trying to correct the bug yourself is the
132quickest way to fix it. Even if you fail to do it, you may
e5795ba9
VZ
133discover valuable information allowing us to fix it while doing
134it. We also give much higher priority to bug reports with patches
135fixing the problems so this ensures that your report will be
136addressed sooner.
4e3ad7c0 137
5147354c
JS
138The Windows HTML Help files are located in docs/htmlhelp.
139The Windows Help files are located in docs/winhelp.
2dc5505e 140The PDF help files are located in docs/pdf.
5147354c 141The HTB (wxWidgets HTML Help) files are located in docs/htb.
2dc5505e
JS
142
143Further information
144-------------------
145
fc2171bd 146The wxWidgets Web site is located at:
2dc5505e 147
fc2171bd 148 http://www.wxwidgets.org
2dc5505e 149
fc2171bd 150The main wxWidgets ftp site is at:
2dc5505e 151
f44b23b6 152 ftp://biolpc22.york.ac.uk/pub
2dc5505e 153
fc2171bd 154A wxWidgets CD-ROM with the latest distribution plus an HTML
2dc5505e 155front-end and hundreds of MB of compilers, utilities and other
fc2171bd 156material may be ordered from the CD-ROM page: see the wxWidgets
ab85e6cd 157web site.
2dc5505e 158
bc00e715 159Have fun!
2dc5505e 160
3273f834 161The wxWidgets Team, January 2007
41c09d48 162