]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/readme.txt
Removed GetSize from wxToolBar95
[wxWidgets.git] / docs / readme.txt
... / ...
CommitLineData
1wxWindows 2.0.1
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 700-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
21Platforms supported
22-------------------
23
24wxWindows 2 currently supports the following platforms:
25
26- Windows 3.1, Windows 95/98, Windows NT
27- Most Unix variants with Motif/Lesstif
28- Most Unix variants with GTK+
29
30Most popular C++ compilers are supported; see the release notes
31(available via docs/html/index.htm) for details.
32
33Files
34-----
35
36Depending on what you downloaded, you may have one or more of
37these ports. You may unarchive any or all of the ports into
38the same directory hierarchy. The zip archive set comprises the
39following:
40
41wx200gen.zip Generic source code and samples (required)
42wx200msw.zip Windows-specific source code
43wx200mot.zip Motif-specific source code
44wx200gtk.zip GTK-specific source code
45wx200stubs.zip Stubs ('empty port') source. Needs
46 wx200gen.zip/tgz.
47wx200doc.zip Documentation source code (not required)
48wx200hlp.zip WinHelp documentation
49wx200pdf.zip Acrobat PDF documentation
50wx200htm.zip HTML documentation
51wx200vc.zip MS VC++ 5/6 project files
52wx200bc.zip Borland C++ 5 project files
53wx200cw.zip Metrowerks CodeWarrior 4.1 project files
54
55The tarred, gzip archive comprises the following (or similar
56names). Not all of these files are available in all distributions, due
57to space restrictions.
58
59wx200gtk.tgz All wxGTK source and samples
60wx200mot.tgz All wxMotif source and samples
61wx200stubs.tgz Stubs ('empty port') source. Needs
62 wx200gen.zip/tgz.
63wx200gen.tgz Generic code and samples (common to all ports)
64wx200pdf.tgz Acrobat PDF documentation
65wx200htm.tgz HTML documentation
66wx200src.tgz Documentation source
67
68Installation
69------------
70
71wxWindows 2 needs to be compiled before you can test out
72the samples or write your own applications.
73For installation information, please see the install.txt file
74in the individual directories:
75
76 docs/msw
77 docs/gtk
78 docs/motif
79
80Licence information
81-------------------
82
83For licensing information, please see the files:
84
85 docs/preamble.txt
86 docs/licence.txt
87 docs/licendoc.txt
88 docs/gpl.txt
89 docs/lgpl.txt
90
91Although this may seem complex, it is there to allow authors of
92proprietary/commercial applications to use wxWindows in
93addition to those writing GPL'ed applications. In summary,
94the licence is L-GPL plus a clause allowing unrestricted
95distribution of application binaries. To answer a FAQ, you
96don't have to distribute any source if you wish to write
97commercial applications using wxWindows.
98
99Documentation
100-------------
101
102See docs/changes.txt for a history of changes to wxWindows 2.
103See docs/html/index.htm for an HTML index of the major documents.
104
105The Windows help files are located in docs/winhelp.
106The PDF help files are located in docs/pdf.
107
108Further information
109-------------------
110
111The wxWindows Web site is located at:
112
113 http://www.wxwindows.org
114
115The wxGTK Web site (with further wxGTK-specific files and
116information) is located at:
117
118 http://www.freiburg.linux.de/~wxxt
119
120The main wxWindows ftp site is at:
121
122 ftp://www.remstar.com/pub/wxwin
123
124A wxWindows CD-ROM with the latest distribution plus an HTML
125front-end and hundreds of MB of compilers, utilities and other
126material may be ordered from the CD-ROM page:
127
128 http://www.wxwindows.org/cdrom.htm
129
130or contact Julian Smart <julian.smart@ukonline.co.uk>.
131
132Good luck!
133
134The wxWindows Team, March 1st, 1999
135