]> git.saurik.com Git - wxWidgets.git/blob - docs/readme.txt
1. New classes documented: wxCriticalSection, wxMutexLocker,
[wxWidgets.git] / docs / readme.txt
1 wxWindows 2.0
2 -------------
3
4 Welcome to wxWindows 2.0, a sophisticated cross-platform C++
5 framework for writing advanced GUI applications using (where
6 possible) the native controls.
7
8 In addition to common and advanced GUI facilities such as frames, scrolling
9 windows, toolbars, tree controls, icons, device contexts,
10 printing, splitter windows and so on, there are wrappers for common
11 file operations and facilities for writing TCP/IP applications.
12 Where certain features are not available on a platform, such as MDI and
13 tree controls on Unix, they are emulated.
14
15 A detailed 700-page reference manual is supplied in HTML, PDF and
16 Windows Help form.
17
18 Platforms supported
19 -------------------
20
21 wxWindows 2.0 currently supports the following platforms:
22
23 - Windows 3.1, Windows 95/98, Windows NT
24 - Unix with Motif/Lesstif
25 - Unix with GTK+
26
27 Files
28 -----
29
30 Depending on what you downloaded, you may have one or more of
31 these ports. You may unarchive any or all of the ports into
32 the same directory hierarchy. The zip archive set comprises the
33 following:
34
35 wx200gen.zip Generic source code and samples (required)
36 wx200msw.zip Windows-specific source code
37 wx200mot.zip Motif-specific source code
38 wx200gtk.zip GTK-specific source code
39 wx200doc.zip Documentation source code (not required)
40 wx200hlp.zip WinHelp documentation
41 wx200pdf.zip Acrobat PDF documentation
42 wx200htm.zip HTML documentation
43 wx200vc.zip MS VC++ 5.0 project files
44 wx200cw.zip Metrowerks CodeWarrior project files
45
46 Installation
47 ------------
48
49 wxWindows 2.0 needs to be compiled before you can test out
50 the samples or write your own applications.
51 For installation information, please see the install.txt file
52 in the individual directories:
53
54 docs/msw
55 docs/gtk
56 docs/motif
57
58 Licence information
59 -------------------
60
61 For licensing information, please see the files:
62
63 docs/preamble.txt
64 docs/licence.txt
65 docs/licendoc.txt
66 docs/gpl.txt
67 docs/lgpl.txt
68
69 Although this may seem complex, it is there to allow authors of
70 proprietary/commercial applications to use wxWindows in
71 addition to those writing GPL'ed applications. In summary,
72 the licence is L-GPL plus a clause allowing unrestricted
73 distribution of application binaries. To answer a FAQ, you
74 don't have to distribute any source if you wish to write
75 commercial applications using wxWindows.
76
77 Documentation
78 -------------
79
80 See docs/changes.txt for a history of changes to wxWindows 2.0.
81 See docs/html/index.htm for an HTML index of the major documents.
82
83 The Windows help files are located in docs/winhelp.
84 The PDF help files are located in docs/pdf.
85
86 Further information
87 -------------------
88
89 The wxWindows Web site is located at:
90
91 http://wxwin.home.ml.org
92
93 The wxGTK Web site (with further wxGTK-specific fiels and
94 information) is located at:
95
96 http://www.freiburg.linux.de/~wxxt
97
98 The main wxWindows ftp site is at:
99
100 ftp://www.remstar.com/pub/wxwin
101
102 A wxWindows CD-ROM with the latest distribution plus an HTML
103 front-end and hundreds of MB of compilers, utilities and other
104 material may be ordered from the CD-ROM page:
105
106 http://wxwin.home.ml.org/cdrom
107
108 or contact Julian Smart <julian.smart@ukonline.co.uk>.
109
110 Good luck!
111
112 The wxWindows Team, January 1999
113