Globally use "wxWindows licence" consistently.
[wxWidgets.git] / docs / gtk / readme.txt
1    Welcome to wxWidgets for GTK+
2    -----------------------------
3
4 You have downloaded the GTK+ port of the wxWidgets GUI library.
5
6 It is required to use at least GTK+ 2.4 and some features are 
7 only available when using GTK+ 2.8 or higher. Note that if you
8 compile wxWidgets against GTK+ 2.8 your app will still work
9 with older GTK+ version down to version 2.4 as wxWidgets
10 tests for the presence of newer features at run-time and it
11 will fall back to a generic implementation if these features
12 are not present in the GTK+ version used.
13
14 wxWidgets 2.8 still supports GTK+ 1.2, but no developement
15 is done on that port anymore and support for GTK+ 1.2 will
16 probably be dropped entirely. Indeed, one of the major steps
17 in the developement cycle leading up to wxWidgets 2.8 was
18 that the codebase for GTK+ 1.2 and GTK+ 2.0 were separated
19 so that improvements and clean-ups to the GTK+ 2.0 port 
20 could be done without caring for GTK+ 1.2.
21
22 More info about the wxWidgets project (including all the
23 other ports and version of wxWidgets) can be found at the
24 main wxWidgets homepage at:
25
26                   http://www.wxwidgets.org/
27   
28 Information on how to install can be found in the file 
29 INSTALL.txt, but if you cannot wait, this should work on
30 many systems:
31
32     mkdir build_gtk
33     cd build_gtk
34     ../configure
35     make
36     su <type root password>
37     make install
38     ldconfig
39
40 In order to use wxGTK with GTK 1.2 you need to use --with-gtk=1
41 configure option. To build the library in Unicode mode (all
42 strings will be wide strings and so on) you need to configure
43 with GTK 2.0 and add --enable-unicode.
44
45 Please note that it is strongly advised to build the library in
46 a separate directory, as shown above, as it allows you to have
47 different builds of it (for example with and without debug) in
48 parallel. If you build in the source directory, don't forget to
49 do "make clean" before changing the configuration!
50
51 When you run into problems, please read the INSTALL.txt and 
52 follow those instructions. If you still don't have any success,
53 please send a bug report to one of our mailing list, INCLUDING 
54 A DESCRIPTION OF YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR 
55 VERSION OF GTK, WXGTK, WHAT DISTRIBUTION YOU USE AND WHAT ERROR 
56 WAS REPORTED. I know this has no effect, but I tried...
57
58 Please send problems concerning installation, feature requests, 
59 bug reports or comments to the wxWidgets users list. These can
60 be found at http://www.wxwidgets.org and more specifically at 
61 http://lists.wxwidgets.org.
62
63 wxWidgets doesn't come with any guarantee whatsoever. It 
64 might crash your harddisk or destroy your monitor. It doesn't 
65 claim to be suitable for any special or general purpose.
66
67   Regards,
68
69     Robert Roebling
70