add note for wxWidgets user with a skeleton for a very minimal console app

[wxWidgets.git] / docs / gtk / readme.txt

diff --git a/docs/gtk/readme.txt b/docs/gtk/readme.txt
index 69fd183db019537255182967f11d64097e97ffa9..89fcbec894dd4c83efc6981bb0a5135328602610 100644 (file)
--- a/docs/gtk/readme.txt
+++ b/docs/gtk/readme.txt
@@ -1,43 +1,52 @@
-
-   Welcome to wxWindows/Gtk 2.1.13
-
-you have downloaded version 2.1 of the GTK+ 1.2 port of 
-the wxWindows GUI library. Although this is not yet the
-final stable release wxGTK 2.2, the current version has
-been tested carefully on many systems and has been found
-to work better than any other previous version.
-
-Nonetheless, beware that major changes can happen before 
-a final release.
-
-wxWindows no longer supports GTK 1.0 (as did some early
-snapshots) so that you will need GTK 1.2 when using it.
-
-Beginning with snapshot 9, wxWindows uses a completely
-new make file system on Unix which no longer uses the
-various GNU tools and I hope that I'll never again have
-to write any more makefiles.
-
-More information is available from my homepage at:
-
-  http://wesley.informatik.uni-freiburg.de/~wxxt
-  
-and about the wxWindows project as a whole (and the MSW
-and Motif ports in particular) can be found at Julian's 
-homepage at:
-
-  http://web.ukonline.co.uk/julian.smart/wxwin
+   Welcome to wxWidgets for GTK+
+   -----------------------------
+
+You have downloaded the GTK+ port of the wxWidgets GUI library.
+
+It is required to use at least GTK+ 2.4 and some features are 
+only available when using GTK+ 2.8 or higher. Note that if you
+compile wxWidgets against GTK+ 2.8 your app will still work
+with older GTK+ version down to version 2.4 as wxWidgets
+tests for the presence of newer features at run-time and it
+will fall back to a generic implementation if these features
+are not present in the GTK+ version used.
+
+wxWidgets 2.8 still supports GTK+ 1.2, but no developement
+is done on that port anymore and support for GTK+ 1.2 will
+probably be dropped entirely. Indeed, one of the major steps
+in the developement cycle leading up to wxWidgets 2.8 was
+that the codebase for GTK+ 1.2 and GTK+ 2.0 were separated
+so that improvements and clean-ups to the GTK+ 2.0 port 
+could be done without caring for GTK+ 1.2.
+
+More info about the wxWidgets project (including all the
+other ports and version of wxWidgets) can be found at the
+main wxWidgets homepage at:
+
+                  http://www.wxwidgets.org/

   
 Information on how to install can be found in the file 
 INSTALL.txt, but if you cannot wait, this should work on
 many systems:
 
   
 Information on how to install can be found in the file 
 INSTALL.txt, but if you cannot wait, this should work on
 many systems:
 

-./configure --with-gtk
-make
-su <type root password>
-make install
-ldconfig
-exit
+    mkdir build_gtk
+    cd build_gtk
+    ../configure
+    make
+    su <type root password>
+    make install
+    ldconfig
+
+In order to use wxGTK with GTK 1.2 you need to use --with-gtk=1
+configure option. To build the library in Unicode mode (all
+strings will be wide strings and so on) you need to configure
+with GTK 2.0 and add --enable-unicode.
+
+Please note that it is strongly advised to build the library in
+a separate directory, as shown above, as it allows you to have
+different builds of it (for example with and without debug) in
+parallel. If you build in the source directory, don't forget to
+do "make clean" before changing the configuration!

 
 When you run into problems, please read the INSTALL.txt and 
 follow those instructions. If you still don't have any success,
 
 When you run into problems, please read the INSTALL.txt and 
 follow those instructions. If you still don't have any success,


@@ -46,17 +55,12 @@ A DESCRIPTION OF YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR
 VERSION OF GTK, WXGTK, WHAT DISTRIBUTION YOU USE AND WHAT ERROR 
 WAS REPORTED. I know this has no effect, but I tried...
 
 VERSION OF GTK, WXGTK, WHAT DISTRIBUTION YOU USE AND WHAT ERROR 
 WAS REPORTED. I know this has no effect, but I tried...
 

-The library produced by the install process will be called 
-libwx_gtk.a (static) and libwx_gtk-2.1.so.13.0.0 (shared) so 
-that once a binary incompatible version of wxWindows/Gtk comes 
-out we'll augment the library version number to avoid linking 
-problems.
-

 Please send problems concerning installation, feature requests, 
 Please send problems concerning installation, feature requests, 

-bug reports or comments to the wxWindows users list. Information 
-on how to subscribe is available from my homepage.
+bug reports or comments to the wxWidgets users list. These can
+be found at http://www.wxwidgets.org and more specifically at 
+http://lists.wxwidgets.org.

 
 

-wxWindows/Gtk doesn't come with any guarantee whatsoever. It 
+wxWidgets doesn't come with any guarantee whatsoever. It 

 might crash your harddisk or destroy your monitor. It doesn't 
 claim to be suitable for any special or general purpose.
 
 might crash your harddisk or destroy your monitor. It doesn't 
 claim to be suitable for any special or general purpose.
 


@@ -64,5 +68,3 @@ claim to be suitable for any special or general purpose.
 
     Robert Roebling
 
 
     Robert Roebling
 

-
-