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