]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/readme.txt
wxMSW: return correct value from wxMessageDialog::GetReturnCode().
[wxWidgets.git] / docs / readme.txt
index 3187c92b47cd82cebd63414ce1d8fec46d194478..896cc8da129c0623fadbf5d669a867fa039619d9 100644 (file)
@@ -1,26 +1,42 @@
-               wxWidgets 2.9.1 Release Notes
+               wxWidgets 2.9.5 Release Notes
                =============================
 
-Welcome to the latest release of wxWidgets, a cross-platform C++
-framework for writing advanced GUI applications using native
-controls where possible.
+Welcome to the latest release of wxWidgets, a free cross-platform C++
+framework for writing advanced GUI applications using 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.
+file operations, facilities for writing network applications,
+thread handling, and so on. You can learn more about wxWidgets at
+
+        http://www.wxwidgets.org/
+
+
+wxWidgets sources are available for download from
+
+        https://sourceforge.net/projects/wxwindows/files/2.9.5/
+
+or
+
+        ftp://ftp.wxwidgets.org/pub/2.9.5/
+
+Please see the "Files" section below for the description of various
+files available at these locations.
+
 
 A detailed reference manual including in-depth overviews for various
 topics is supplied in various formats and can be accessed online at
-http://docs.wxwidgets.org/
 
+        http://docs.wxwidgets.org/2.9.5/
 
-Note about naming: while 2.9.1 is called a "development" release,
-this only means that API is not guaranteed to remain unchanged in
-the subsequent 2.9.x releases, unlike in the stable 2.8.x branch. We
-believe the current version is stable and suitable for use in
-production environment.
+
+Note about naming: while 2.9.5 is called a "development" release,
+this only means that API is not guaranteed to remain unchanged in the
+subsequent 2.9.x releases (although it is still likely that it will),
+unlike in the stable 2.8.x branch. We believe the current version is
+stable and suitable for use in production environment.
 
 
 
@@ -34,6 +50,15 @@ when using a release build of the library, was much improved making
 it less likely that you use the library incorrectly. Many new GUI
 and base classes have been added or improved.
 
+Compared to the previous 2.9.4 release the most important change at
+the API level is the introduction of new, shorter constants for the
+event types making code using Bind() for dynamic event handling easier
+to both write and read. But the main focus of this release is on
+incremental improvements and fixing defects in preparation for 3.0
+release. In particular, wxOSX/Cocoa port has been significantly
+improved. And there were fixes to the still exprimental wxGTK3 port
+which now also support GTK+ Broadway (HTML5-based) backend.
+
 Please see the file docs/changes.txt for more details and make sure
 to read the section "Incompatible changes since 2.8" if you upgrade
 from a previous wxWidgets release.
@@ -51,14 +76,15 @@ Platforms supported
 wxWidgets currently supports the following primary platforms:
 
 - Windows 95/98/ME, NT, 2000, XP, Vista, 7
-- Most Unix variants using the GTK+ toolkit (version 2.4 or newer)
-- Mac OS X (10.4 or newer) using either Carbon or Cocoa
+- Most Unix variants using the GTK+ toolkit (version 2.6 or newer)
+- Mac OS X (10.5 or newer) using either Carbon or Cocoa
 
 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 GTK+ 3 (still in development)
 - OS/2
 - Windows CE (Pocket PC)
 
@@ -71,8 +97,24 @@ date status.
 Files
 -----
 
-The distribution is available in archive formats appropriate to the
-target system. See the download pages for details.
+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.
+
+Experimentally, we also supply binaries of wxMSW libraries built
+with several versions of Microsoft Visual C++ compiler for this
+release. They are available in the "binaries" subdirectory, see
+the description of the files in the README file there.
 
 
 Installation
@@ -94,6 +136,7 @@ For licensing information, please see the files:
   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
@@ -133,7 +176,7 @@ Documentation
 -------------
 
 wxWidgets documentation is available online at
-http://docs.wxwidgets.org/2.9.1/ and can also be downloaded in HTML
+http://docs.wxwidgets.org/2.9.5/ and can also be downloaded in HTML
 format. To generate documentation in other formats (PDF, CHM, ...)
 please use the scripts in docs/doxygen directory.
 
@@ -160,11 +203,11 @@ Further information
 
 The wxWidgets Web site is located at:
 
-  http://www.wxwidgets.org
+  http://www.wxwidgets.org/
 
 The main wxWidgets ftp site is at:
 
-  ftp://biolpc22.york.ac.uk/pub
+  ftp://ftp.wxwidgets.org/pub/
 
 A wxWidgets CD-ROM with the latest distribution plus an HTML
 front-end and hundreds of MB of compilers, utilities and other
@@ -173,5 +216,4 @@ web site.
 
 Have fun!
 
-The wxWidgets Team, July 2010
-
+The wxWidgets Team, July 2013