Introducing wxBase for borland based on Michael Fieldings patch 598106
[wxWidgets.git] / docs / base / readme.txt
1                                 wxBase README
2                                 =============
3
4 NB: this file applies to wxBase library only. If you are using a GUI version
5     of wxWindows, please refer to the documentation in the appropriate
6     subdirectory (msw, gtk, motif &c).
7
8
9  Welcome to wxBase!
10
11 0. Introduction
12 ---------------
13
14  wxBase is the library providing most of the non-GUI classes of the wxWindows
15 cross-platform C++ framework. wxBase has some generic classes such as yet
16 another C++ string class, typesafe dynamic arrays, hashes and lists and, more
17 excitingly, wxDateTime - a very flexible and powerful class for manipulating
18 the dates in the range of 580 million years with up to millisecond precision.
19 Another useful class not present in the standard C++ library is wxRegEx which
20 allows you to use regular expressions for string matching and replacing.
21
22  There are also classes for writing portable programs in C++ painlessly which
23 encapsulate things like files (and their names), directories, processes,
24 threads, sockets and much more. Some of the other utility classes allow you to
25 parse the command line, limit the number of instances of your program
26 executing simultaneously (portably!) and so on.
27
28 1. Requirements and supported platforms
29 --------------------------------------
30
31  wxBase can be compiled and used under Win32, mostly any modern Unix system
32 (probably including Mac OS X but it wasn't tested there), VMS and BeOS (this
33 release couldn't be tested under these platforms neither so you might
34 encounter some problems but they should be easy to solve - please contact us
35 in this case!)
36
37  It is written without using any modern C++ features (such as templates,
38 exceptions, namespaces) for maximal portability and so you shouldn't have
39 problems compiling it with any C++ compiler at all. However, we only provide
40 the project files for Microsoft Visual C++ 6.0 for Win32 (any contributions
41 are welcome!) - but our Unix makefiles will work with any compiler.
42
43 2. Installing under Win32
44 -------------------------
45
46 Please note that wxBase can be compiled in different configurations under
47 Win32: as a static or shared library, in debug or release mode and in ANSI
48 or Unicode mode for a total of 8 possibilities.
49
50 a) Using Visual C++ 6.0
51
52    Simply open the src/wxBase.dsw file in MSDEV and build it. When it is
53 done you can also open samples/console/console.dsp project and build it as
54 well.
55
56 b) Cygwin
57
58    Please refer to the Unix section below
59
60 c) Borland
61    Please refer to the docs/msw/install.txt. The console sample compiles and runs
62    but does not pass all tests (04 sept 02)
63
64 d) Other compilers
65
66    Unfortunately we don't have the makefiles for any other compilers yet.
67 Please contact us if you would like to help us with creating one for the
68 compiler you use.
69
70 3. Installing under Unix/BeOS
71 -----------------------------
72
73 NB: If you're building wxBase from the wxWindows distribution and not from a
74     separate wxBase one you will need to add "--disable-gui" to configure
75     arguments below!
76
77 Please note that GNU make is required to build wxBase!
78
79 The recommended way to build wxBase is:
80
81         % cd ..../wxWindows
82         % mkdir base-release
83         % cd base-release
84         % ../configure
85         # ignore the error messages about missing samples
86         % make
87         % make install
88
89 You can also do:
90
91         % mkdir base-debug
92         % cd base-debug
93         % ../configure --enable-debug
94         % make
95
96 To build the sample then cd to samples/console and make there.
97
98 4. Documentation and support
99 ----------------------------
100
101  The console sample provided with this distribution tests most (but not all)
102 wxBase classes. It doesn't do anything useful per itself but you may want to
103 look at its code to see examples of usage of the class you are interested in.
104
105  There is no separate documentation for wxBase, please refer to wxWindows
106 documentation instead.
107
108  Support for wxBase is available from the same places as for wxWindows itself,
109 namely:
110
111 * Usenet newsgroup comp.soft-sys.wxwindows
112
113 * Mailing lists: see http://lists.wxwindows.org/ for more information
114
115 * WWW page: http://www.wxwindows.org/
116
117
118  Hope you will find wxBase useful!
119
120                                                                  Vadim Zeitlin
121
122
123 This file is accurate for the version 2.3.2 of wxBase. It was last modified on
124 Dec 11, 2001.
125