wxWidgets/docs
Vadim Zeitlin 73747c457c Document wxOSX/Carbon removal
Mention that requesting it from configure is now silently ignored.
2016-02-03 18:19:14 +01:00
..
base Updated links and mailing list addresses. 2015-10-30 20:06:09 -06:00
contributing Clarify location of built release packages. 2015-11-15 21:31:38 -07:00
dfb Updated links and mailing list addresses. 2015-10-30 20:06:09 -06:00
doxygen Remove wxOSX/Carbon support. 2016-02-01 13:48:48 +01:00
gtk Remove obsolete symbols from overviews and install notes 2015-12-03 21:26:31 +01:00
motif Remove obsolete symbols from overviews and install notes 2015-12-03 21:26:31 +01:00
msw Updated links and mailing list addresses. 2015-10-30 20:06:09 -06:00
osx Remove wxOSX/Carbon support. 2016-02-01 13:48:48 +01:00
publicity
qt Updated links and mailing list addresses. 2015-10-30 20:06:09 -06:00
tech
univ Remove obsolete symbols from overviews and install notes 2015-12-03 21:26:31 +01:00
vms
wine
x11 Remove obsolete symbols from overviews and install notes 2015-12-03 21:26:31 +01:00
changes_30.txt Don't mention that wxVariant doesn't derive from wxObject 2015-10-22 00:02:59 +02:00
changes.txt Document wxOSX/Carbon removal 2016-02-03 18:19:14 +01:00
gpl.txt
index.htm Updated links and mailing list addresses. 2015-10-30 20:06:09 -06:00
lgpl.txt
licence.txt
licendoc.txt
preamble.txt
readme.txt Remove wxOSX/Carbon support. 2016-02-01 13:48:48 +01:00
release.md Release script improvements. 2015-11-15 13:56:52 -07:00
xserver.txt

wxWidgets 3.1.0 Release Notes
=============================

Welcome to the latest development release of wxWidgets, a free and open source
cross-platform C++ framework for writing advanced GUI applications using native
controls.

wxWidgets allows you to write native-looking GUI applications for all the major
desktop platforms and also helps with abstracting the differences in the non-GUI
aspects between them. It is free for the use in both open source and commercial
applications, comes with the full, easy to read and modify, source and extensive
documentation and a collection of more than a hundred examples. You can learn
more about wxWidgets at:

* https://www.wxwidgets.org/

Documentation is available online at:

* http://docs.wxwidgets.org/3.1.0/

wxWidgets sources and binaries for the selected platforms are available for
download from:

* https://github.com/wxWidgets/wxWidgets/releases/tag/v3.1.0/


Changes
-------




Platforms Supported
-------------------

wxWidgets currently supports the following primary platforms:

* Windows XP, Vista, 7, 8 and 10 (32/64 bits).
* Most Unix variants using the GTK+ toolkit (version 2.6 or newer)
* Mac OS X (10.7 or newer) using Cocoa (32/64 bits)

There is some support for the following platforms:

* Most Unix variants with X11
* Most Unix variants with Motif/Lesstif
* Most Unix variants with GTK+ 1.2
* Most Unix variants with Qt 5 or newer

Most popular C++ compilers are supported; see the install.txt file for each
platform (available via docs/html/index.htm) and
https://wiki.wxwidgets.org/Supported_Platforms for the most up to date status.


Files
-----

wxWidgets is distributed in source form in several archive formats. ZIP and 7z
archives are for Microsoft Windows users and contain the files with DOS/Windows
line endings while the compressed tar archives for Unix systems users (including
OS X) and contain the files with Unix line endings. Please notice that some
Windows tools still don't accept files with Unix line endings and that compiling
sources with DOS line endings under Unix will fail, so please choose the correct
file for your system.

In addition to the sources, documentation in HTML, CHM and HTB (wxWidgets help
viewer) formats is provided as well as an installer for Microsoft Windows.
Notice that you will still need to compile wxWidgets even when using the
installer.

We also supply binaries of wxMSW libraries built with several versions of
Microsoft Visual C++ and GNU g++ compiler for this release.


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

Unless you have downloaded the binaries for your compiler, you will need to
build wxWidgets before you can test out the samples or write your own
applications. For installation information, please see the install.txt file in
the docs subdirectory appropriate for the platform you use.


Licence
-------

For licensing information, please see the files:

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

Although this may seem complex, it is there to allow authors of proprietary,
commercial applications to use wxWidgets 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
wxWidgets.

However, if you distribute wxGTK, wxQt or wxMotif (with Lesstif) version of your
application, don't forget that it is linked against GTK+, Qt or Lesstif, which
are covered by LGPL *without* exception notice and so is bound by its
requirements.

If you use TIFF image handler, please see src/tiff/COPYRIGHT for libtiff licence
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.

If you use wxRegEx class on a system without native regular expressions support
(i.e. MS Windows), see src/regex/COPYRIGHT file for Henry Spencer's regular
expression library copyright.

If you use wxXML classes or XRC, see src/expat/COPYING for licence details.


Reporting Bugs
--------------

The wxWidgets bug tracker can be found here:

* http://trac.wxwidgets.org/newticket

Please use the search function of our Trac installation to find any possibly
relevant bugs before reporting new ones. Also please notice that often trying to
correct the bug yourself is the quickest way to fix it. Even if you fail to do
it, you may discover valuable information allowing us to fix it while doing it.
We also give much higher priority to bug reports with patches fixing the
problems so this ensures that your report will be addressed sooner.


Further Information
-------------------

If you are looking for support, you can get it from

* Mailing Lists: https://www.wxwidgets.org/support/mailing-lists/
* Discussion Forums: https://forums.wxwidgets.org/
* #wxwidgets IRC Channel: https://www.wxwidgets.org/support/irc/
* Stack Overflow (tag your questions with "wxwidgets"):
  https://stackoverflow.com/questions/tagged/wxwidgets

Have fun!

The wxWidgets Team, June 2016