fixed wxMutexLocker ctor signature (patch 660549)

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

diff --git a/docs/univ/readme.txt b/docs/univ/readme.txt
index 554ed793d13b3d1676f86bfd38da975e7d85a941..ee7322c12972f03e48bcbcef855291d9a76f30d4 100644 (file)
--- a/docs/univ/readme.txt
+++ b/docs/univ/readme.txt
@@ -1,61 +1,72 @@
-                             wxUniversal README
-                             ==================
+                              wxUniversal README
+                              ==================

 
 

- Welcome to wxUniversal!
+Welcome to wxUniversal!

 
 

- Acknowledgements: wxUniversal wouldn't have been written without the
-generous support of SciTech Software. Many thanks to Kendall Benett and
+Acknowledgements: wxUniversal wouldn't have been written without the
+generous support of SciTech Software. Many thanks to Kendall Bennett and

 Tom Ryan!
 
 0. Introduction
 ---------------
 
 Tom Ryan!
 
 0. Introduction
 ---------------
 

- wxUniversal is a port of wxWindows which implements the various GUI controls
+wxUniversal is a port of wxWindows which implements the various GUI controls

 by drawing them itself (using low level wxWindows classes). Please see
 
 by drawing them itself (using low level wxWindows classes). Please see
 

-                    http://www.wxwindows.org/wxuniv.htm
+                     http://www.wxwindows.org/wxuniv.htm

 
 for more details about it.
 
 
 for more details about it.
 

- The advantage of wxUniversal is that you have precise control over the
+The advantage of wxUniversal is that you have precise control over the

 controls' appearance (it is not always possible to change all aspects of the
 native controls) and the theme support: the same program may be changed to
 look completely differently without changing a single line of its code but
 just changing the theme.
 
 controls' appearance (it is not always possible to change all aspects of the
 native controls) and the theme support: the same program may be changed to
 look completely differently without changing a single line of its code but
 just changing the theme.
 

- Another advantage is that it makes writing ports of wxWindows for other
+Another advantage is that it makes writing ports of wxWindows for other

 platforms (such as OS/2, BeOS or QNX) much simpler, so it is of special
 interest to people interested in porting wxWindows to another platform.
 
 platforms (such as OS/2, BeOS or QNX) much simpler, so it is of special
 interest to people interested in porting wxWindows to another platform.
 

- However, wxUniversal doesn't have a 100% native look and feel unlike the
+However, wxUniversal doesn't have a 100% native look and feel unlike the

 other wxWindows ports - this is the price to pay for the extra flexibility.
 
 1. Requirements and supported platforms
 ---------------------------------------
 
 other wxWindows ports - this is the price to pay for the extra flexibility.
 
 1. Requirements and supported platforms
 ---------------------------------------
 

- wxUniversal is used together with another wxWindows port which provides the
-"low level classes" mentioned above. Currently it can be built either with
-wxMSW or wxGTK. In any case, you should download the sources for the
+wxUniversal is used together with another wxWindows port which provides the
+"low level classes" mentioned above. Currently it can be built with wxMSW,
+wxGTK or wxX11. In any case, you should download the sources for the

 appropriate toolkit in addition to wxUniversal - in fact, you should download
 them first and then unpack wxUniversal in the same directory.
 
 appropriate toolkit in addition to wxUniversal - in fact, you should download
 them first and then unpack wxUniversal in the same directory.
 

- The requirments for wxUniversal are the same as for the underlying low level
+The requirements for wxUniversal are the same as for the underlying low level

 toolkit.
 
 2. Installing under Win32
 -------------------------
 
 toolkit.
 
 2. Installing under Win32
 -------------------------
 

+If compiling from CVS, please copy include/wx/univ/setup0.h
+to include/wx/univ/setup.h before following these steps.
+

 a) Using Visual C++ 6.0
 
    Simply open the src/wxUniv.dsw file in DevStudio and build it.
 a) Using Visual C++ 6.0
 
    Simply open the src/wxUniv.dsw file in DevStudio and build it.

+   Then open the widgetsUniv.dsp file in samples/widgets to build
+   the widgets sample.

 
 b) Cygwin
 
    Please refer to the Unix section below
 
 c) Other compilers
 
 b) Cygwin
 
    Please refer to the Unix section below
 
 c) Other compilers

-
-   Unfortunately we don't have makefiles for any other compilers yet.
+   Borland: 
+   in the wxwindows\src\msw directory run
+   'make -f makefile.b32 WXUSINGUNIV=1' to build the library and then run
+   'make -f makefile.b32 WXUSINGUNIV=1' in the sample directory  which you wish
+   to build using the wxUniversal widgets. Use 'SET WXTHEME=GTK' [or  WIN32 or METAL]
+   to test the existing themes
+
+Unfortunately we don't have makefiles for any other compilers yet.

 Please contact us if you would like to help us with creating one for the
 compiler you use.
 
 Please contact us if you would like to help us with creating one for the
 compiler you use.
 


@@ -66,22 +77,42 @@ documented here. Please see docs/univ/readme.txt for further information.
 3. Installing under Unix
 ------------------------
 
 3. Installing under Unix
 ------------------------
 

-Please refer to the installation instructions for wxGTK. The only change for
-wxUniversal is that you must add "--enable-univ" switch to the configure
-command line.
+Please refer to the installation instructions for wxGTK or wxX11. The only
+change for wxUniversal is that you must add "--enable-universal" switch to
+the configure command line and for wxX11 even this is unnecessary, i.e. it
+is enabled by default.
+
+If compiling from CVS, please copy include/wx/univ/setup0.h
+to include/wx/univ/setup.h before configuring.
+
+4. Running wxUniv programs
+--------------------------
+
+wxUniv programs all honour the standard option "--theme" which allows to
+specify the theme to be used by name. Currently there are the following
+themes:

 
 

-4. Documentation and support
+a) win32 -- Windows 95 look and feel
+b) metal -- based on win32 but with gradient backgrounds
+c) gtk   -- GTK+ 1.x standard look and feel
+
+Thus, to launch a program using gtk theme you may do "./program --theme=gtk".
+
+It is also possible to change the default theme for all wxUniv applications
+at once by setting the environment variable WXTHEME to the theme name.
+
+5. Documentation and support

 ----------------------------
 
 ----------------------------
 

- Please note that wxUniversal is not as mature as the other wxWindows ports
+Please note that wxUniversal is not as mature as the other wxWindows ports

 and is currently officially in alpha stage. In particular, it is not really
 intended for the end users but rather for developers at the current stage and
 this is why we don't provide any binaries for it.
 
 and is currently officially in alpha stage. In particular, it is not really
 intended for the end users but rather for developers at the current stage and
 this is why we don't provide any binaries for it.
 

- There is no separate documentation for wxUniversal, please refer to wxWindows
+There is no separate documentation for wxUniversal, please refer to wxWindows

 documentation instead.
 
 documentation instead.
 

- Support for wxUniversal is available from the same places as for wxWindows
+Support for wxUniversal is available from the same places as for wxWindows

 itself, namely:
 
 * Usenet newsgroup comp.soft-sys.wxwindows
 itself, namely:
 
 * Usenet newsgroup comp.soft-sys.wxwindows


@@ -93,10 +124,9 @@ itself, namely:
 
  Hope you find wxUniversal useful!
 
 
  Hope you find wxUniversal useful!
 

-                                                                Vadim Zeitlin
-
+                                                                 Vadim Zeitlin

 
 

-This file is accurate for the version 2.3.2 of wxUniversal. It was last
-modified on Dec 11, 2001.

 
 

+This file is accurate for the version 2.3.4 of wxUniversal. It was last
+modified on Apr 15, 2002.