]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/readme.txt
small corrections for dnd code and added wxFileDataObject demo to the sample
[wxWidgets.git] / docs / readme.txt
... / ...
CommitLineData
1wxWindows 2.1.10
2----------------
3
4Welcome to wxWindows 2, a sophisticated cross-platform C++
5framework for writing advanced GUI applications using (where
6possible) the native controls.
7
8In addition to common and advanced GUI facilities such as frames, scrolling
9windows, toolbars, tree controls, icons, device contexts, printing,
10splitter windows and so on, there are wrappers for common file operations,
11and facilities for writing TCP/IP applications, thread handling, and more.
12Where certain features are not available on a platform, such as MDI and
13tree controls on Unix, they are emulated.
14
15A detailed 1100-page reference manual is supplied in HTML, PDF and
16Windows Help form: see the docs hierarchy.
17
18For a quick start, point your Web browser at docs/html/index.htm for a list of
19important documents and samples.
20
21Changes in this release
22-----------------------
23
24These are the major improvements:
25
26wxWindows 2.1.10
27================
28
29- Numerous bug fixes and consistency improvements.
30- Further samples.
31- Factoring out of some code into base classes, for easier
32 maintenance.
33- Integration of wxHTML widget and help controller into
34 wxWindows. wxHTML allows HTML viewing and printing.
35- New classes wxChrono, wxDialUpManager, wxFontEnumerator,
36 wxWizard, etc.
37- wxSocket and wxThread classes rewritten.
38- Documentation improvements.
39
40Platforms supported
41-------------------
42
43wxWindows 2 currently supports the following platforms:
44
45- Windows 3.1, Windows 95/98, Windows NT
46- Most Unix variants with Motif/Lesstif
47- Most Unix variants with GTK+
48- Mac (not covered here: please see the wxWindows web site
49 for details)
50
51Most popular C++ compilers are supported; see the release notes
52(available via docs/html/index.htm) for details.
53
54Files
55-----
56
57The distribution is available in a number of formats.
58The most convenient is the platform-specific distribution,
59but the zip set forms a more complete distribution, for example if
60you wish to take part in wxWindows development. Also, add-ons
61such as OGL may only be available in zip form.
62
63Zip set
64-------
65
66Depending on what you downloaded, you may have one or more of
67these ports. You may unarchive any or all of the ports into
68the same directory hierarchy. The zip archive set comprises the
69following:
70
71wx200gen.zip Generic source code and samples (required)
72wx200msw.zip Windows-specific source code
73wx200mot.zip Motif-specific source code
74wx200gtk.zip GTK-specific source code
75wx200stubs.zip Stubs ('empty port') source. Needs
76 wx200gen.zip/tgz.
77wx200doc.zip Documentation source code (not required)
78wx200hlp.zip WinHelp documentation
79wx200pdf.zip Acrobat PDF documentation
80wx200htm.zip HTML documentation
81wx200vc.zip MS VC++ 5/6 project files
82wx200bc.zip Borland C++ 5 project files
83wx200cw.zip Metrowerks CodeWarrior 4.1 project files
84jpeg.zip Optional JPEG library
85ogl3.zip Optional Object Graphics Library
86glcanvas.zip Optional wxGLCanvas class (Motif, GTK, MSW)
87tex2rtf2.zip Tex2RTF documentation tool
88
89wxWindows for GTK distribution
90------------------------------
91
92wxGTK-2.x.x.tgz wxGTK source distribution. You will
93 need the HTML and/or PDF documentation
94 from the zip set (above).
95
96wxWindows for Motif distribution
97--------------------------------
98
99wxMotif-2.x.x.tgz wxMotif source distribution. You will
100 need the HTML and/or PDF documentation
101 -- OR -- from the zip set (above).
102
103wx200gen.zip
104wx200msw.zip
105wx200mot.zip
106jpeg.zip
107
108wxWindows for Windows distribution
109----------------------------------
110
111As well as the core source, the Windows setup contains:
112
113- Windows Help versions of the documentation (docs/winhelp);
114- wxGLCanvas (OpenGL integration, in utils/glcanvas);
115- OGL 3 (Object Graphics Library, in utils/ogl);
116- wxTreeLayout (for tree drawing, in utils/wxtree);
117- a Dialog Editor binary;
118- the JPEG library.
119
120setup.exe Setup file (Windows 95/98, NT)
121setup.* Other setup files
122
123Installation
124------------
125
126wxWindows 2 needs to be compiled before you can test out
127the samples or write your own applications.
128For installation information, please see the install.txt file
129in the individual directories:
130
131 docs/msw
132 docs/gtk
133 docs/motif
134
135Licence information
136-------------------
137
138For licensing information, please see the files:
139
140 docs/preamble.txt
141 docs/licence.txt
142 docs/licendoc.txt
143 docs/gpl.txt
144 docs/lgpl.txt
145
146Although this may seem complex, it is there to allow authors of
147proprietary/commercial applications to use wxWindows in
148addition to those writing GPL'ed applications. In summary,
149the licence is L-GPL plus a clause allowing unrestricted
150distribution of application binaries. To answer a FAQ, you
151don't have to distribute any source if you wish to write
152commercial applications using wxWindows.
153
154Documentation
155-------------
156
157See docs/changes.txt for a detailed history of changes to wxWindows 2.
158See docs/html/index.htm for an HTML index of the major documents.
159
160The Windows help files are located in docs/winhelp.
161The PDF help files are located in docs/pdf.
162
163Further information
164-------------------
165
166The wxWindows Web site is located at:
167
168 http://www.wxwindows.org
169
170The wxGTK Web site (with further wxGTK-specific files and
171information) is located at:
172
173 http://www.freiburg.linux.de/~wxxt
174
175The main wxWindows ftp site is at:
176
177 ftp://www.remstar.com/pub/wxwin
178
179A wxWindows CD-ROM with the latest distribution plus an HTML
180front-end and hundreds of MB of compilers, utilities and other
181material may be ordered from the CD-ROM page (see the wxWindows
182web site) or contact Julian Smart <julian.smart@ukonline.co.uk>.
183
184Good luck!
185
186The wxWindows Team, November 1999
187