]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/base/readme.txt
Penguin Unicode compilation fix.
[wxWidgets.git] / docs / base / readme.txt
index 78e1ac4058801e80d9a9f026a92188cc8e7531b1..c6e654e0f6e45b8fa8abffdb34cca34402f81c9b 100644 (file)
@@ -1,5 +1,5 @@
-                               wxBase README
-                               =============
+                                wxBase README
+                                =============
 
 NB: this file applies to wxBase library only. If you are using a GUI version
     of wxWindows, please refer to the documentation in the appropriate
@@ -14,7 +14,7 @@ NB: this file applies to wxBase library only. If you are using a GUI version
  wxBase is the library providing most of the non-GUI classes of the wxWindows
 cross-platform C++ framework. wxBase has some generic classes such as yet
 another C++ string class, typesafe dynamic arrays, hashes and lists and, more
-excitingly, wxDateTime - a very flexible and powerful class for manipulating
+excitingly, wxDateTime -- a very flexible and powerful class for manipulating
 the dates in the range of 580 million years with up to millisecond precision.
 Another useful class not present in the standard C++ library is wxRegEx which
 allows you to use regular expressions for string matching and replacing.
@@ -25,20 +25,22 @@ threads, sockets and much more. Some of the other utility classes allow you to
 parse the command line, limit the number of instances of your program
 executing simultaneously (portably!) and so on.
 
+
 1. Requirements and supported platforms
 --------------------------------------
 
  wxBase can be compiled and used under Win32, mostly any modern Unix system
-(probably including Mac OS X but it wasn't tested there), VMS and BeOS (this
-release couldn't be tested under these platforms neither so you might
-encounter some problems but they should be easy to solve - please contact us
-in this case!)
+(including Mac OS X), VMS and BeOS (this release couldn't be tested under
+these platforms so you might encounter some problems but they should be easy
+to solve -- please contact us in this case!)
 
  It is written without using any modern C++ features (such as templates,
 exceptions, namespaces) for maximal portability and so you shouldn't have
 problems compiling it with any C++ compiler at all. However, we only provide
-the project files for Microsoft Visual C++ 6.0 for Win32 (any contributions
-are welcome!) - but our Unix makefiles will work with any compiler.
+the project files for Microsoft Visual C++ 6.0 and make files for Borland C++
+for Win32 (any contributions are welcome!) -- but our Unix makefiles should
+work with any compiler.
+
 
 2. Installing under Win32
 -------------------------
@@ -55,14 +57,33 @@ well.
 
 b) Cygwin
 
-   Please refer to the Unix section below
+   Please refer to the Unix section below.
+
+c) Borland
+
+   Please refer to the docs/msw/install.txt. The console sample compiles and
+   runs but does not pass all tests (04 sept 02)
+
+d) Watcom
 
-c) Other compilers
+   The compilation has been tested only with OpenWatcom but should also work
+   with Watcom 11.0 but probably not the earlier versions.
+
+   To build wxBase itself (only static library build is supported), enter the
+   directory src\msw and type "wmake -f makebase.wat". See also Watcom notes in
+   docs/msw/install.txt.
+
+   There is makefile.wat in samples\console which can be used to build the
+   console sample with Watcom and also shows how can you write your own
+   makefiles for wxBase and Watcom compiler.
+
+e) Other compilers
 
    Unfortunately we don't have the makefiles for any other compilers yet.
 Please contact us if you would like to help us with creating one for the
 compiler you use.
 
+
 3. Installing under Unix/BeOS
 -----------------------------
 
@@ -70,27 +91,29 @@ NB: If you're building wxBase from the wxWindows distribution and not from a
     separate wxBase one you will need to add "--disable-gui" to configure
     arguments below!
 
-Please note that GNU make is required to build wxBase!
+Please note that GNU make may be required to build wxBase, please use it if
+you get any errors from the native Unix make.
 
 The recommended way to build wxBase is:
 
-       % cd ..../wxWindows
-       % mkdir base-release
-       % cd base-release
-       % ../configure
-       # ignore the error messages about missing samples
-       % make
-       % make install
+        % cd ..../wxWindows
+        % mkdir base-release # or any other directory of your liking
+        % cd base-release
+        % ../configure
+        # ignore the error messages about missing samples
+        % make
+        % make install
 
 You can also do:
 
-       % mkdir base-debug
-       % cd base-debug
-       % ../configure --enable-debug
-       % make
+        % mkdir base-debug
+        % cd base-debug
+        % ../configure --enable-debug
+        % make
 
 To build the sample then cd to samples/console and make there.
 
+
 4. Documentation and support
 ----------------------------
 
@@ -113,9 +136,9 @@ namely:
 
  Hope you will find wxBase useful!
 
-                                                                Vadim Zeitlin
+                                                                 Vadim Zeitlin
 
 
-This file is accurate for the version 2.3.2 of wxBase. It was last modified on
-Dec 11, 2001.
+This file is accurate for the version 2.5.0 of wxBase. It was last modified on
+Jan 22, 2003.