]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/readme.txt
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / docs / readme.txt
... / ...
CommitLineData
1wxWidgets 2.5.2
2---------------
3
4*** Please note that this is an UNSTABLE DEVELOPMENT SNAPSHOT.
5*** Unless you need the new features and bug fixes, you may wish to
6*** use the official 2.4.x stable series. You are still encouraged
7*** to try the releases from 2.5.x branch, of course, and unstable
8*** doesn't mean that they crash all the time -- just that the API
9*** may change in backwards incompatible way. If this doesn't frighten
10*** you, do try this release and please let us know what you think!
11
12Welcome to wxWidgets, a sophisticated cross-platform C++
13framework for writing advanced GUI applications using (where
14possible) the native controls.
15
16In addition to common and advanced GUI facilities such as
17frames, scrolling windows, toolbars, tree controls, icons,
18device contexts, printing, splitter windows and so on, there are
19wrappers for common file operations, and facilities for writing
20TCP/IP applications, thread handling, and more. Where certain
21features are not available on a platform, such as MDI and tree
22controls on Unix, they are emulated.
23
24A detailed 1800-page reference manual is supplied in HTML, PDF
25and Windows Help form: see the docs hierarchy.
26
27For a quick start, point your Web browser at docs/html/index.htm
28for a list of important documents and samples.
29
30Changes in this release
31-----------------------
32
33Please see changes.txt for details.
34
35Platforms supported
36-------------------
37
38wxWidgets currently supports the following platforms:
39
40- Windows 95/98/ME, Windows NT, Windows 2000, Windows XP, Pocket PC
41- Most Unix variants with GTK+ 1 and GTK+ 2
42- Most Unix variants with X11 (beta)
43- Most Unix variants with Motif/Lesstif
44- MacOS 9.x and 10.x using Carbon (10.3 and above preferred)
45- MacOS 10.x using Cocoa (beta)
46- OS/2 (beta)
47
48Most popular C++ compilers are supported; see the install.txt
49file for each platform (available via docs/html/index.htm) for details.
50See also http://www.wxwidgets.org/platform.htm.
51
52Files
53-----
54
55The distribution is available in archive formats appropriate to the
56target system. See the download pages for details.
57
58Installation
59------------
60
61wxWidgets 2 needs to be compiled before you can test out
62the samples or write your own applications.
63For installation information, please see the install.txt file
64in the individual directories:
65
66 docs/msw
67 docs/gtk
68 docs/motif
69 docs/mac
70 docs/x11
71 docs/mgl
72 docs/os2
73
74Licence information
75-------------------
76
77For licensing information, please see the files:
78
79 docs/preamble.txt
80 docs/licence.txt
81 docs/licendoc.txt
82 docs/gpl.txt
83 docs/lgpl.txt
84
85Although this may seem complex, it is there to allow authors of
86proprietary/commercial applications to use wxWidgets in
87addition to those writing GPL'ed applications. In summary,
88the licence is LGPL plus a clause allowing unrestricted
89distribution of application binaries. To answer a FAQ, you
90don't have to distribute any source if you wish to write
91commercial applications using wxWidgets.
92
93However, if you distribute wxGTK or wxMotif (with Lesstif) version
94of your application, don't forget that it is linked against
95GTK+ (or Lesstif) which is covered by LGPL *without* exception
96notice. Under Linux systems your app is probably linked
97against LGPL glibc as well. Please read carefully LGPL, section 6.
98which describes conditions for distribution of closed source applications
99linked against LGPL library. Basically you should link dynamically and
100include source code of LGPL libraries with your product (unless it is
101already present in user's system - like glibc usually is).
102If compiled with --enable-odbc (Unix only), wxWidgets library will
103contain iODBC library which is covered 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 should
109contain following sentence: "This software is based in part on the work of
110the Independent JPEG Group". See src/jpeg/README for details.
111
112If you use wxRegEx class on a system without native regular expressions
113support (i.e. MS Windows), see src/regex/COPYRIGHT file for Henry Spencer's
114regular expression library copyright.
115
116If you use wxXML classes or XRC, see src/expat/COPYING for licence details.
117
118Documentation
119-------------
120
121See docs/html/index.htm for an HTML index of the major documents.
122
123See docs/changes.txt for a summary of changes to wxWidgets 2.
124
125See docs/tech for an archive of technical notes.
126
127The wxWidgets bug database can be browsed at:
128
129 http://sourceforge.net/bugs/?group_id=9863
130
131The Windows help files are located in docs/winhelp.
132The PDF help files are located in docs/pdf.
133
134Further information
135-------------------
136
137The wxWidgets Web site is located at:
138
139 http://www.wxwidgets.org
140
141The main wxWidgets ftp site is at:
142
143 ftp://biolpc22.york.ac.uk/pub
144
145A wxWidgets CD-ROM with the latest distribution plus an HTML
146front-end and hundreds of MB of compilers, utilities and other
147material may be ordered from the CD-ROM page: see the wxWidgets
148web site.
149
150Have fun!
151
152The wxWidgets Team, May 2004
153