]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/readme.txt
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fixed typo in wxFileName::GetHumanReadableSize docs.
[wxWidgets.git] / docs / readme.txt
diff --git a/docs/readme.txt b/docs/readme.txt
index db2aee3c64cdcd7f2fd7d4f98d1f9d108378716a..3187c92b47cd82cebd63414ce1d8fec46d194478 100644 (file)
--- a/docs/readme.txt
+++ b/docs/readme.txt
@@ -1,68 +1,72 @@
-wxWidgets 2.7.0
----------------------------------------------------------
-
-Welcome to wxWidgets, a sophisticated cross-platform C++
-framework for writing advanced GUI applications using
-native controls where possible.
-
-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 2000-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.
-
-Releases in the 2.7 series are considered development releases,
-and as such, each new release may contain significant new
-features or code changes which have not yet received thorough
-testing and/or may break ABI or API compatibility with previous
-releases. Therefore, we recommend that you keep this in mind if
-you are to base your software on a 2.7 release, and thoroughly
-test the parts of the wx library your application uses.  Rest
-assured however that these potentially incompatible changes are
-made in order to evolve the toolkit to the next ABI stable
-release series (2.8.x) and that normally efforts are made to
-preserve compilation compatibility, so often moving to a new
-development release just requires a full recompile of the
-application using wxWidgets.
+               wxWidgets 2.9.1 Release Notes
+               =============================
+
+Welcome to the latest release of wxWidgets, a cross-platform C++
+framework for writing advanced GUI applications using native
+controls where possible.
+
+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.
+
+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/
+
+
+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.
+
 
 
 Changes in this release
 -----------------------
 
 
 
 Changes in this release
 -----------------------
 
-Please see changes.txt and "Changes since 2.4" in the manual
-for details.
+This release contains several years worth of improvements compared
+to 2.8 version. Notably, Unicode support has been completely
+overhauled and made much easier to use. Debugging support, including
+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.
+
+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.
+
+This release introduces many important changes and we are looking
+forward to your feedback about them. In particular please let us
+know about any regressions compared to the previous versions (see
+the section "Bug reporting" below) so that we could fix them before
+3.0 release.
+
 
 Platforms supported
 -------------------
 
 
 Platforms supported
 -------------------
 
-wxWidgets currently supports the following platforms:
+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
 
 
-- Windows 95/98/ME, Windows NT, Windows 2000, Windows XP,
-  Pocket PC, Smartphone
-- Most Unix variants with GTK+ 1 and GTK+ 2
-- Most Unix variants with X11 (beta)
+There is some support for the following platforms:
+
+- Most Unix variants with X11
 - Most Unix variants with Motif/Lesstif
 - Most Unix variants with Motif/Lesstif
-- MacOS 9.x and 10.x using Carbon (10.3 and above preferred)
-- MacOS 10.x using Cocoa (beta)
-- OS/2 (beta)
-- PalmOS (alpha)
+- Most Unix variants with GTK+ 1.2
+- OS/2
+- Windows CE (Pocket PC)
 
 Most popular C++ compilers are supported; see the install.txt
 
 Most popular C++ compilers are supported; see the install.txt
-file for each platform (available via docs/html/index.htm) for details.
-See also http://www.wxwidgets.org/platform.htm.
+file for each platform (available via docs/html/index.htm) and
+http://wiki.wxwidgets.org/Supported_Platforms for the most up to
+date status.
 
 
-Note that 2.6 series were the last to fully support GTK+ 1.2, and Mac OS
-9/Mac OS 10.2 and below. wxWidgets 2.7 and above focuses on GTK+ 2 and Mac OS
-10.3 and above and compatibility with earlier systems is not guaranteed any
-more.
 
 Files
 -----
 
 Files
 -----
@@ -70,22 +74,15 @@ Files
 The distribution is available in archive formats appropriate to the
 target system. See the download pages for details.
 
 The distribution is available in archive formats appropriate to the
 target system. See the download pages for details.
 
+
 Installation
 ------------
 
 wxWidgets needs to be compiled before you can test out the samples
 or write your own applications. For installation information, please
 Installation
 ------------
 
 wxWidgets 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
-  docs/mac
-  docs/cocoa
-  docs/x11
-  docs/mgl
-  docs/os2
-  docs/palmos
+see the install.txt file in the docs subdirectory appropriate for
+the platform you use.
+
 
 Licence information
 -------------------
 
 Licence information
 -------------------
@@ -104,7 +101,7 @@ 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
 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. 
+applications using wxWidgets.
 
 However, if you distribute wxGTK or wxMotif (with Lesstif)
 version of your application, don't forget that it is linked
 
 However, if you distribute wxGTK or wxMotif (with Lesstif)
 version of your application, don't forget that it is linked
@@ -115,9 +112,7 @@ against LGPL glibc as well. Please read carefully LGPL, section
 applications linked against LGPL library. Basically you should
 link dynamically and include source code of LGPL libraries with
 your product (unless it is already present in user's system -
 applications linked against LGPL library. Basically you should
 link dynamically 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), wxWidgets library will contain iODBC library which is
-covered by LGPL.
+like glibc usually is).
 
 If you use TIFF image handler, please see src/tiff/COPYRIGHT
 for libtiff licence details.
 
 If you use TIFF image handler, please see src/tiff/COPYRIGHT
 for libtiff licence details.
@@ -133,23 +128,32 @@ file for Henry Spencer's regular expression library copyright.
 
 If you use wxXML classes or XRC, see src/expat/COPYING for licence details.
 
 
 If you use wxXML classes or XRC, see src/expat/COPYING for licence details.
 
+
 Documentation
 -------------
 
 Documentation
 -------------
 
-See docs/html/index.htm for an HTML index of the major documents.
+wxWidgets documentation is available online at
+http://docs.wxwidgets.org/2.9.1/ and can also be downloaded in HTML
+format. To generate documentation in other formats (PDF, CHM, ...)
+please use the scripts in docs/doxygen directory.
 
 
-See docs/changes.txt for a summary of changes to wxWidgets.
 
 
-See docs/tech for an archive of technical notes.
+Bug reporting
+-------------
+
+The wxWidgets bug tracker can be browsed at:
 
 
-The wxWidgets bug database can be browsed at:
+    http://trac.wxwidgets.org/report
 
 
-  http://sourceforge.net/bugs/?group_id=9863
+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.
 
 
-The Windows HTML Help files are located in docs/htmlhelp.
-The Windows Help files are located in docs/winhelp.
-The PDF help files are located in docs/pdf.
-The HTB (wxWidgets HTML Help) files are located in docs/htb.
 
 Further information
 -------------------
 
 Further information
 -------------------
@@ -169,5 +173,5 @@ web site.
 
 Have fun!
 
 
 Have fun!
 
-The wxWidgets Team, September 2005
+The wxWidgets Team, July 2010
 
 
wxWidgets (Impactor)