moved wxUniv readme to its own directory
[wxWidgets.git] / docs / univ / readme.txt
1                               wxUniversal README
2                               ==================
3
4  Welcome to wxUniversal!
5
6  Acknowledgements: wxUniversal wouldn't have been written without the
7 generuous support of SciTech Software. Many thanks to Kendall Benett and
8 Tom Ryan!
9
10 0. Introduction
11 ---------------
12
13  wxUniversal is a port of wxWindows which implements the various GUI controls
14 by drawing them itself (using low level wxWindows classes). Please see
15
16                      http://www.wxwindows.org/wxuniv.htm
17
18 for more details about it.
19
20  The advantage of wxUniversal is that you have precise control over the
21 controls appearance (it is not always possible to change all aspects of the
22 native controls) and the theme support: the same program may be changed to
23 look completely differently  without changing a single line of its code but
24 just changing the theme.
25
26  Another advantage is that it makes writing ports of wxWindows for other
27 platforms (such as OS/2, BeOS or QNX) much simpler, so it is of special
28 interest to the people interested in porting wxWindows to another platform.
29
30  However, wxUniversal doesn't have the 100% native look and feel unlike the
31 other wxWindows ports - this is the price to pay for the extra flexibility.
32
33 1. Requirments and supported platforms
34 --------------------------------------
35
36  wxUniversal is used together with another wxWindows port which provides the
37 "low level classes" mentioned above. Currently it can be built either with
38 wxMSW or wxGTK. In any case, you should download the sources for the
39 appropriate toolkit in addition to wxUniversal - in fact, you should download
40 them first and then unpack wxUniversal in the same directory.
41
42  The requirments for wxUniversal are the same as for the underlying low level
43 toolkit.
44
45 2. Installing under Win32
46 -------------------------
47
48 a) Using Visual C++ 6.0
49
50    Simply open the src/wxUniv.dsw file in MSDEV and build it.
51
52 b) Cygwin
53
54    Please refer to the Unix section below
55
56 c) Other compilers
57
58    Unfortunately we don't have the makefiles for any other compilers yet.
59 Please contact us if you would like to help us with creating one for the
60 compiler you use.
61
62 3. Installing under Unix
63 ------------------------
64
65 Please refer to the installation instructions for wxGTK. The only change for
66 wxUniversal is that you must add "--enable-univ" switch to the configure
67 command line.
68
69 4. Documentation and support
70 ----------------------------
71
72  Please note that wxUniversal is not as mature as the other wxWindows ports
73 and is currently officially in alpha stage. In particular, it is not really
74 intended for the end users but rather for developers at the current stage and
75 this is why we don't provide any binaries for it.
76
77  There is no separate documentation for wxUniversal, please refer to wxWindows
78 documentation instead.
79
80  Support for wxUniversal is available from the same places as for wxWindows
81 itself, namely:
82
83 * Usenet newsgroup comp.soft-sys.wxwindows
84
85 * Mailing lists: see http://lists.wxwindows.org/ for more information
86
87 * WWW page: http://www.wxwindows.org/
88
89
90  Hope you will find wxUniversal useful!
91
92                                                                  Vadim Zeitlin
93
94
95 This file is accurate for the version 2.3.2 of wxUniversal. It was last
96 modified on Dec 11, 2001.
97
98