Document domain parameter of wxTranslations::GetTranslatedString().
[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.6 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.6 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.9.4 adds support for GTK+ 3, which can be enabled
15 with configure option --with-gtk=3. Note that this port is
16 still in development and may have significant bugs or missing
17 features, and should be considered experimental.
18
19 wxWidgets 2.8 still supports GTK+ 1.2, but no developement
20 is done on that port anymore and support for GTK+ 1.2 will
21 probably be dropped entirely. Indeed, one of the major steps
22 in the developement cycle leading up to wxWidgets 2.8 was
23 that the codebase for GTK+ 1.2 and GTK+ 2.0 were separated
24 so that improvements and clean-ups to the GTK+ 2.0 port 
25 could be done without caring for GTK+ 1.2.
26
27 More info about the wxWidgets project (including all the
28 other ports and version of wxWidgets) can be found at the
29 main wxWidgets homepage at:
30
31                   http://www.wxwidgets.org/
32   
33 Information on how to install can be found in the file 
34 INSTALL.txt, but if you cannot wait, this should work on
35 many systems:
36
37     mkdir build_gtk
38     cd build_gtk
39     ../configure
40     make
41     su <type root password>
42     make install
43     ldconfig
44
45 In order to use wxGTK with GTK 1.2 you need to use --with-gtk=1
46 configure option. To build the library in Unicode mode (all
47 strings will be wide strings and so on) you need to configure
48 with GTK 2.0 and add --enable-unicode.
49
50 Please note that it is strongly advised to build the library in
51 a separate directory, as shown above, as it allows you to have
52 different builds of it (for example with and without debug) in
53 parallel. If you build in the source directory, don't forget to
54 do "make clean" before changing the configuration!
55
56 When you run into problems, please read the INSTALL.txt and 
57 follow those instructions. If you still don't have any success,
58 please send a bug report to one of our mailing list, INCLUDING 
59 A DESCRIPTION OF YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR 
60 VERSION OF GTK, WXGTK, WHAT DISTRIBUTION YOU USE AND WHAT ERROR 
61 WAS REPORTED. I know this has no effect, but I tried...
62
63 Please send problems concerning installation, feature requests, 
64 bug reports or comments to the wxWidgets users list. These can
65 be found at http://www.wxwidgets.org and more specifically at 
66 http://lists.wxwidgets.org.
67
68 wxWidgets doesn't come with any guarantee whatsoever. It 
69 might crash your harddisk or destroy your monitor. It doesn't 
70 claim to be suitable for any special or general purpose.
71
72   Regards,
73
74     Robert Roebling
75