Go to file
Julian Smart d6a3816816 Added WXDLLEXPORT keywords
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6887 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2000-03-21 10:39:00 +00:00
contrib Docview mended (grrr) and OGL studio partially working under wxGTK 2000-03-20 13:41:16 +00:00
debian configure changes, for wxBase and wx-config 2000-02-24 12:20:22 +00:00
demos Added a Motif-only extra call to UpdateInfoText() just after frame creation 2000-03-19 23:19:52 +00:00
distrib 1. some (benign) warnings fixed 2000-03-20 18:41:55 +00:00
docs wxThread::Kill() doesn't call OnExit() incorrectly 2000-03-20 17:39:18 +00:00
include Added WXDLLEXPORT keywords 2000-03-21 10:39:00 +00:00
lib no message 2000-03-10 06:23:53 +00:00
locale some old Danish translations 2000-03-19 14:18:16 +00:00
misc these aren't being used any more 2000-01-26 18:14:05 +00:00
samples Win16 BC++ makefile fixes, other v. small fixes 2000-03-20 16:32:55 +00:00
src 1. some (benign) warnings fixed 2000-03-20 18:41:55 +00:00
tests MSW compilation fixes 1999-05-10 22:56:03 +00:00
user CW5.2 Pro Adaptions, wxMac starting to move in 1999-11-05 09:16:09 +00:00
utils Misc small changes 2000-03-19 19:55:13 +00:00
.cvsignore more files to ignore (build dirs names, tags files) 2000-01-28 20:58:32 +00:00
autogen.sh New makefile system in place, obsoletes libtool, 1999-08-12 12:54:33 +00:00
BuildCVS.txt Modified Mingw32 makefiles to compile with Mingw32 2.95 or earlier; 1999-10-22 12:03:54 +00:00
config.guess second try... 1999-06-01 16:14:29 +00:00
config.sub second try... 1999-06-01 16:14:29 +00:00
configure 1. some (benign) warnings fixed 2000-03-20 18:41:55 +00:00
configure.in 1. some (benign) warnings fixed 2000-03-20 18:41:55 +00:00
descrip.mms Committing in . 2000-03-16 08:07:59 +00:00
difflast.pl bug fixes 2000-03-16 16:30:14 +00:00
install-sh second try... 1999-06-01 16:14:29 +00:00
make-deb added wxPython control files and a few changes 2000-02-21 23:02:25 +00:00
Makefile.in 1. some (benign) warnings fixed 2000-03-20 18:41:55 +00:00
Mingw32-gcc295.patches Patch to add extern "C" to winsock.h in gcc2.95 2000-03-20 12:57:26 +00:00
mkinstalldirs this file is needed, after all... 1999-06-01 16:27:39 +00:00
modules Created wxSamples 1999-11-23 12:52:02 +00:00
regen regenerate several files at once, not only one 2000-01-08 15:46:33 +00:00
setup.h_vms Committing in . 2000-03-16 08:07:59 +00:00
setup.h.in 1. corrected HAVE_PW_GECOS detection in configure (which never worked) 2000-03-19 16:45:43 +00:00
wx-config.in added --cc, cxx, ld options to wx-config 2000-01-06 18:34:49 +00:00
wxBase.dsp 1. fixed memory leak in GAddress 2000-03-16 01:12:31 +00:00
wxBase.spec Various corrections to makefiles, RPMs etc. 2000-02-01 16:37:28 +00:00
wxGTK.spec Great. A dot mssing in the spec file so I can start 2000-03-20 18:51:59 +00:00
wxMotif.spec Minor optical things. 2000-02-24 18:09:48 +00:00
wxWINE.spec Distrib and make install fixes. 1999-08-26 16:15:38 +00:00

wxWindows 2.1.14
----------------

Welcome to wxWindows 2, a sophisticated cross-platform C++
framework for writing advanced GUI applications using (where
possible) the native controls.

In addition to common and advanced GUI facilities such as frames, scrolling
windows, toolbars, tree controls, icons, device contexts, printing,
splitter windows and so on, there are wrappers for common file operations,
and facilities for writing TCP/IP applications, thread handling, and more.
Where certain features are not available on a platform, such as MDI and
tree controls on Unix, they are emulated.

A detailed 1100-page reference manual is supplied in HTML, PDF and
Windows Help form: see the docs hierarchy.

For a quick start, point your Web browser at docs/html/index.htm for a list of
important documents and samples.

Changes in this release
-----------------------

Please see changes.txt for details.

Note that there is a new contrib hierarchy for contributions,
which mirrors the regular wxWindows hierarchy. The Object
Graphics Library and MMedia library have been moved under
contrib, so you may need to change your makefiles or project
files, together with your source files. E.g. change #include "ogl.h"
to #include <wx/ogl/ogl>.

Also VC++ project files and makefiles have been made more
consistent, so some paths and library names have changed.

Platforms supported
-------------------

wxWindows 2 currently supports the following platforms:

- Windows 3.1, Windows 95/98, Windows NT
- Most Unix variants with Motif/Lesstif
- Most Unix variants with GTK+
- Mac (not covered here: please see the wxWindows web site
  for details)

Most popular C++ compilers are supported; see the install.txt
file for each platform (available via docs/html/index.htm) for details.

Files
-----

The distribution is available in a number of formats.
The most convenient is the platform-specific distribution,
but the zip set forms a more complete distribution, for example if
you wish to take part in wxWindows development. Also, add-ons
such as OGL may only be available in zip form.

Zip set
-------

Depending on what you downloaded, you may have one or more of
these ports. You may unarchive any or all of the ports into
the same directory hierarchy. The zip archive set comprises the
following, where x is the minor version and y the release number:

wx2_x_y_gen.zip            Generic source code and samples (required)
wx2_x_y_msw.zip            Windows-specific source code
wx2_x_y_mot.zip            Motif-specific source code
wx2_x_y_gtk.zip            GTK-specific source code
wx2_x_y_stubs.zip          Stubs ('empty port') source. Needs
                           wx2_x_y_gen.zip/tgz.
wx2_x_y_doc.zip            Documentation source code (not required)
wx2_x_y_hlp.zip            WinHelp documentation
wx2_x_y_pdf.zip            Acrobat PDF documentation
wx2_x_y_htm.zip            HTML documentation
wx2_x_y_vc.zip             MS VC++ 5/6 project files
wx2_x_y_bc.zip             Borland C++ 5 project files
wx2_x_y_cw.zip             Metrowerks CodeWarrior 4.1 project files
jpeg.zip                   Optional JPEG library
tiff.zip                   Optional TIFF library
ogl3.zip                   Optional Object Graphics Library
mmedia.zip                 Optional MMedia class library (Motif, GTK, MSW)
stc.zip                    Optional wxStyledTextCtrl library (Motif, GTK, MSW)
tex2rtf2.zip               Tex2RTF documentation tool

wxWindows for GTK distribution
------------------------------

wxGTK-2.x.y.tgz            wxGTK source distribution. You will
                           need the HTML and/or PDF documentation
                           from the zip set (above).

wxWindows for Motif distribution
--------------------------------

wxMotif-2.x.y.tgz          wxMotif source distribution. You will
                           need the HTML and/or PDF documentation
   -- OR --                from the zip set (above).

wx2_x_y_gen.zip
wx2_x_y_mot.zip
jpeg.zip
tiff.zip

wxWindows for Windows distribution
----------------------------------

As well as the core source, the Windows setup contains:

- Windows Help versions of the documentation (docs/winhelp);
- wxGLCanvas (OpenGL integration, in utils/glcanvas);
- OGL 3 (Object Graphics Library, in utils/ogl);
- wxTreeLayout (for tree drawing, in utils/wxtree);
- a Dialog Editor binary;
- the JPEG library.

setup.exe               Setup file (Windows 95/98, NT)
setup.*                 Other setup files

Installation
------------

wxWindows 2 needs to be compiled before you can test out
the samples or write your own applications.
For installation information, please see the install.txt file
in the individual directories:

  docs/msw
  docs/gtk
  docs/motif

Licence information
-------------------

For licensing information, please see the files:

  docs/preamble.txt
  docs/licence.txt
  docs/licendoc.txt
  docs/gpl.txt
  docs/lgpl.txt

Although this may seem complex, it is there to allow authors of
proprietary/commercial applications to use wxWindows in
addition to those writing GPL'ed applications. In summary,
the licence is LGPL plus a clause allowing unrestricted
distribution of application binaries. To answer a FAQ, you
don't have to distribute any source if you wish to write
commercial applications using wxWindows. 

However, if you distribute wxGTK or wxMotif (with Lesstif) version
of your application, don't forget that it is linked against
GTK+ (or Lesstif) which is covered by LGPL *without* exception
notice. Under Linux systems your app is probably linked
against LGPL glibc as well. Please read carefuly LGPL, section 6.
which describes conditions for distribution of closed source applications
linked against LGPL library. Basically you should link dynamicaly and
include source code of LGPL libraries with your product (unless it is
already present in user's system - like glibc usually is).
If compiled with --enable-odbc (Unix only), wxWindows library will 
contain iODBC library which is covered by LGPL.

If you use TIFF image handler, please see src/tiff/COPYRIGHT
for libtiff license details.

If you use JPEG image handler, documentation for your program should
contain following sentence: "This software is based in part on the work of
the Independent JPEG Group". See src/jpeg/README for details.


Documentation
-------------

See docs/bugs.txt for a bug list: this file is new and will initially
  be edited by hand, later generated from a web-based bug database.

See docs/html/index.htm for an HTML index of the major documents.

See docs/changes.txt for a summary of changes to wxWindows 2.

See docs/tech for an archive of technical notes.

The Windows help files are located in docs/winhelp.
The PDF help files are located in docs/pdf.

Further information
-------------------

The wxWindows Web site is located at:

  http://www.wxwindows.org

The wxGTK Web site (with further wxGTK-specific files and
information) is located at:

  http://www.freiburg.linux.de/~wxxt

The main wxWindows ftp site is at:

  ftp://www.remstar.com/pub/wxwin

A wxWindows CD-ROM with the latest distribution plus an HTML
front-end and hundreds of MB of compilers, utilities and other
material may be ordered from the CD-ROM page (see the wxWindows
web site) or contact Julian Smart <julian.smart@ukonline.co.uk>.

Good luck!

The wxWindows Team, 19 March, 2000