]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/readme.txt
minor fixes to #include
[wxWidgets.git] / docs / readme.txt
... / ...
CommitLineData
1wxWindows 2.3.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.2.x stable series.
7
8Welcome to wxWindows 2, a sophisticated cross-platform C++
9framework for writing advanced GUI applications using (where
10possible) the native controls.
11
12In addition to common and advanced GUI facilities such as
13frames, scrolling windows, toolbars, tree controls, icons,
14device contexts, printing, splitter windows and so on, there are
15wrappers for common file operations, and facilities for writing
16TCP/IP applications, thread handling, and more. Where certain
17features are not available on a platform, such as MDI and tree
18controls on Unix, they are emulated.
19
20A detailed 1700-page reference manual is supplied in HTML, PDF
21and Windows Help form: see the docs hierarchy.
22
23For a quick start, point your Web browser at docs/html/index.htm
24for a list of important documents and samples.
25
26Changes in this release
27-----------------------
28
29Please see changes.txt for details.
30
31Platforms supported
32-------------------
33
34wxWindows 2 currently supports the following platforms:
35
36- Windows 95/98/ME, Windows NT, Windows 2000, Windows XP (see msw/winxp.txt)
37- Most Unix variants with Motif/Lesstif
38- Most Unix variants with GTK+
39- MacOS
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.wxwindows.org/platform.htm.
44
45Files
46-----
47
48The distribution is available in archive formats appropriate to the
49target system. Documentation is available mainly in zip format.
50Some add-on libraries (such as the Object Graphics Library) are
51available in zip form only. In the following, x.y.z represents
52the current version number.
53
54wxWindows for GTK distribution
55------------------------------
56
57wxGTK-x.y.z.tgz wxGTK source distribution. You will
58 need the HTML, HTB and/or PDF documentation
59 (see below)
60wxGTK-demos-x.y.z.tgz wxGTK demos source
61wxGTK-samples-x.y.z.tgz wxGTK samples source
62wxGTK-x.y.z-0.src.rpm wxGTK Linux source as an RPM, without manuals
63wxGTK-x.y.z-0.i386.rpm wxGTK Linux binaries as an RPM, without manuals
64wxGTK-devel-x.y.z-0.i386.rpm wxGTK Linux minimum development system as an RPM
65
66wxWindows for Motif distribution
67--------------------------------
68
69wxMotif-x.y.z.tgz wxMotif source distribution. Contains
70 TIFF, JPEG, Tex2RTF source plus HTML
71 documentation.
72
73wxWindows for MS Windows distribution
74-------------------------------------
75
76setup.exe, setup.w* Setup files (Windows 95/98, NT)
77 in floppy-disk-sized chunks
78wxMSW-x.y.z-setup.zip Zip archive containing the
79 setup files
80wxMSW-x.y.z.zip Zip archive containing all the
81 files that are in the setup
82 distribution
83
84wxWindows for MacOS distribution
85--------------------------------
86
87wxMac-x.y.z.zip Zip archive containing all
88 source files (excludes documentation)
89
90As well as the core source, the wxMSW distribution contains:
91
92- Windows HTML Help versions of the documentation (docs/htmlhelp);
93- Object Graphics Library, in contrib/src/ogl;
94- a Dialog Editor binary;
95- a Tex2RTF binary;
96- Life! sample binary;
97- the JPEG library source;
98- the TIFF library source.
99
100Documentation files
101-------------------
102
103wxWindows-x.y.z-WinHelp.zip WinHelp documentation
104wxWindows-x.y.z-PDF.zip Acrobat PDF documentation
105wxWindows-x.y.z-HTML.zip HTML documentation
106wxWindows-x.y.z-HTMLHelp.zip Windows HTML Help documentation
107wxWindows-x.y.z-HTB.zip wxHTML documentation (for
108 use with the helpview utility)
109wxWindows-x.y.z-Word.zip MS Word documentation (currently,
110 database class documentation only)
111wxWindows-x.y.z-DocSource.zip Documentation source code (not required)
112
113Add-ons
114-------
115
116wxWindows-x.y.z-cw.zip Metrowerks CodeWarrior 4.1 project files
117wxWindows-x.y.z-wat.zip Watcom C++ project files
118wxWindows-x.y.z-vc.zip Visual C++ project files (in wxMSW distr.)
119wxWindows-x.y.z-bc.zip Borland C++ project files (in wxMSW distr.)
120jpeg.zip JPEG library (already included
121 in most distributions)
122tiff.zip TIFF library (already included
123 in most distributions)
124ogl3.zip Optional Object Graphics Library
125mmedia.zip Optional MMedia library (Motif, GTK, MSW)
126stc.zip Optional wxStyledTextCtrl library
127 (Motif, GTK, MSW)
128tex2rtf2.zip Tex2RTF documentation tool
129wxGTK-gl-x.y.z-0.i386.rpm add-on OpenGL binary as an RPM
130
131Installation
132------------
133
134wxWindows 2 needs to be compiled before you can test out
135the samples or write your own applications.
136For installation information, please see the install.txt file
137in the individual directories:
138
139 docs/msw
140 docs/gtk
141 docs/motif
142 docs/mac
143
144Licence information
145-------------------
146
147For licensing information, please see the files:
148
149 docs/preamble.txt
150 docs/licence.txt
151 docs/licendoc.txt
152 docs/gpl.txt
153 docs/lgpl.txt
154
155Although this may seem complex, it is there to allow authors of
156proprietary/commercial applications to use wxWindows in
157addition to those writing GPL'ed applications. In summary,
158the licence is LGPL plus a clause allowing unrestricted
159distribution of application binaries. To answer a FAQ, you
160don't have to distribute any source if you wish to write
161commercial applications using wxWindows.
162
163However, if you distribute wxGTK or wxMotif (with Lesstif) version
164of your application, don't forget that it is linked against
165GTK+ (or Lesstif) which is covered by LGPL *without* exception
166notice. Under Linux systems your app is probably linked
167against LGPL glibc as well. Please read carefuly LGPL, section 6.
168which describes conditions for distribution of closed source applications
169linked against LGPL library. Basically you should link dynamicaly and
170include source code of LGPL libraries with your product (unless it is
171already present in user's system - like glibc usually is).
172If compiled with --enable-odbc (Unix only), wxWindows library will
173contain iODBC library which is covered by LGPL.
174
175If you use TIFF image handler, please see src/tiff/COPYRIGHT
176for libtiff license details.
177
178If you use JPEG image handler, documentation for your program should
179contain following sentence: "This software is based in part on the work of
180the Independent JPEG Group". See src/jpeg/README for details.
181
182If you use wxRegEx class on a system without native regular expressions
183support (i.e. MS Windows), see src/regex/COPYRIGHT file for Henry Spencer's
184regular expression library copyright.
185
186Documentation
187-------------
188
189See docs/html/index.htm for an HTML index of the major documents.
190
191See docs/changes.txt for a summary of changes to wxWindows 2.
192
193See docs/tech for an archive of technical notes.
194
195The Windows help files are located in docs/winhelp.
196The PDF help files are located in docs/pdf.
197
198Further information
199-------------------
200
201The wxWindows Web site is located at:
202
203 http://www.wxwindows.org
204
205The wxGTK Web site (with further wxGTK-specific files and
206information) is located at:
207
208 http://www.freiburg.linux.de/~wxxt
209
210The main wxWindows ftp site is at:
211
212 ftp://www.remstar.com/pub/wxwin
213
214A wxWindows CD-ROM with the latest distribution plus an HTML
215front-end and hundreds of MB of compilers, utilities and other
216material may be ordered from the CD-ROM page: see the wxWindows
217web site.
218
219Have fun!
220
221The wxWindows Team, 10th June, 2001
222