]> git.saurik.com Git - wxWidgets.git/blob - docs/readme.txt
Various small fixes
[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 For a quick start, point your Web browser at docs/html/index.htm for a list of
19 important documents and samples.
20
21 Platforms supported
22 -------------------
23
24 wxWindows 2.0 currently supports the following platforms:
25
26 - Windows 3.1, Windows 95/98, Windows NT
27 - Unix with Motif/Lesstif
28 - Unix with GTK+
29
30 Files
31 -----
32
33 Depending on what you downloaded, you may have one or more of
34 these ports. You may unarchive any or all of the ports into
35 the same directory hierarchy. The zip archive set comprises the
36 following:
37
38 wx200gen.zip Generic source code and samples (required)
39 wx200msw.zip Windows-specific source code
40 wx200mot.zip Motif-specific source code
41 wx200gtk.zip GTK-specific source code
42 wx200doc.zip Documentation source code (not required)
43 wx200hlp.zip WinHelp documentation
44 wx200pdf.zip Acrobat PDF documentation
45 wx200htm.zip HTML documentation
46 wx200vc.zip MS VC++ 5.0 project files
47 wx200cw.zip Metrowerks CodeWarrior project files
48
49 Installation
50 ------------
51
52 wxWindows 2.0 needs to be compiled before you can test out
53 the samples or write your own applications.
54 For installation information, please see the install.txt file
55 in the individual directories:
56
57 docs/msw
58 docs/gtk
59 docs/motif
60
61 Licence information
62 -------------------
63
64 For licensing information, please see the files:
65
66 docs/preamble.txt
67 docs/licence.txt
68 docs/licendoc.txt
69 docs/gpl.txt
70 docs/lgpl.txt
71
72 Although this may seem complex, it is there to allow authors of
73 proprietary/commercial applications to use wxWindows in
74 addition to those writing GPL'ed applications. In summary,
75 the licence is L-GPL plus a clause allowing unrestricted
76 distribution of application binaries. To answer a FAQ, you
77 don't have to distribute any source if you wish to write
78 commercial applications using wxWindows.
79
80 Documentation
81 -------------
82
83 See docs/changes.txt for a history of changes to wxWindows 2.0.
84 See docs/html/index.htm for an HTML index of the major documents.
85
86 The Windows help files are located in docs/winhelp.
87 The PDF help files are located in docs/pdf.
88
89 Further information
90 -------------------
91
92 The wxWindows Web site is located at:
93
94 http://wxwin.home.ml.org
95
96 The wxGTK Web site (with further wxGTK-specific fiels and
97 information) is located at:
98
99 http://www.freiburg.linux.de/~wxxt
100
101 The main wxWindows ftp site is at:
102
103 ftp://www.remstar.com/pub/wxwin
104
105 A wxWindows CD-ROM with the latest distribution plus an HTML
106 front-end and hundreds of MB of compilers, utilities and other
107 material may be ordered from the CD-ROM page:
108
109 http://wxwin.home.ml.org/cdrom
110
111 or contact Julian Smart <julian.smart@ukonline.co.uk>.
112
113 Good luck!
114
115 The wxWindows Team, January 1999
116