]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/readme.txt
added JPEG support
[wxWidgets.git] / docs / readme.txt
... / ...
CommitLineData
1wxWindows 2 beta 3
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,
10printing, splitter windows and so on, there are wrappers for common
11file operations and facilities for writing TCP/IP applications.
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.
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
45wx200doc.zip Documentation source code (not required)
46wx200hlp.zip WinHelp documentation
47wx200pdf.zip Acrobat PDF documentation
48wx200htm.zip HTML documentation
49wx200vc.zip MS VC++ 5.0 project files
50wx200cw.zip Metrowerks CodeWarrior project files
51
52Installation
53------------
54
55wxWindows 2 needs to be compiled before you can test out
56the samples or write your own applications.
57For installation information, please see the install.txt file
58in the individual directories:
59
60 docs/msw
61 docs/gtk
62 docs/motif
63
64Licence information
65-------------------
66
67For licensing information, please see the files:
68
69 docs/preamble.txt
70 docs/licence.txt
71 docs/licendoc.txt
72 docs/gpl.txt
73 docs/lgpl.txt
74
75Although this may seem complex, it is there to allow authors of
76proprietary/commercial applications to use wxWindows in
77addition to those writing GPL'ed applications. In summary,
78the licence is L-GPL plus a clause allowing unrestricted
79distribution of application binaries. To answer a FAQ, you
80don't have to distribute any source if you wish to write
81commercial applications using wxWindows.
82
83Documentation
84-------------
85
86See docs/changes.txt for a history of changes to wxWindows 2.
87See docs/html/index.htm for an HTML index of the major documents.
88
89The Windows help files are located in docs/winhelp.
90The PDF help files are located in docs/pdf.
91
92Further information
93-------------------
94
95The wxWindows Web site is located at:
96
97 http://www.wxwindows.org
98
99The wxGTK Web site (with further wxGTK-specific fiels and
100information) is located at:
101
102 http://www.freiburg.linux.de/~wxxt
103
104The main wxWindows ftp site is at:
105
106 ftp://www.remstar.com/pub/wxwin
107
108A wxWindows CD-ROM with the latest distribution plus an HTML
109front-end and hundreds of MB of compilers, utilities and other
110material may be ordered from the CD-ROM page:
111
112 http://www.wxwindows.org/cdrom.htm
113
114or contact Julian Smart <julian.smart@ukonline.co.uk>.
115
116Good luck!
117
118The wxWindows Team, January 1999
119