]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/readme.txt
update the main page of the manual to be more consistent; update its date
[wxWidgets.git] / docs / readme.txt
index a5fc743fcd0b3fe85e8962579b574574bbc10a14..ee3037773a60a14211ffb6b5a66a564fa5ffb781 100644 (file)
@@ -1,43 +1,27 @@
-wxWidgets 2.7.2
+wxWidgets 2.9.x
 ---------------------------------------------------------
 
-Welcome to wxWidgets, a sophisticated cross-platform C++
-framework for writing advanced GUI applications using
-native controls where possible.
+Welcome to 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. 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.
+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 under Unix and OS X, they are emulated.
+
+A detailed reference manual including in-depth overviews for
+various topics is supplied in various formats and can be
+accessed online.
 
 Changes in this release
 -----------------------
 
-Please see changes.txt and "Changes since 2.6" in the manual
+Please see changes.txt and "Changes since 2.8" in the manual
 for details.
 
 Platforms supported
@@ -45,25 +29,23 @@ Platforms supported
 
 wxWidgets currently supports the following platforms:
 
-- 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)
+- Windows 95/98/ME, NT, 2000, XP, Vista, Pocket PC/Mobile, Smartphone
+- Most Unix variants using the  GTK+ 2 toolkit (version 2.4 or newer)
+- MacOS OS X (10.4 or newer) using Carbon and some Cocao mix-in
+
+There is some support for the followig platforms:
+
+- Most Unix variants with X11
 - 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
+- MacOS 10.x using the Cocoa API
+- OS/2
+- PalmOS
 
 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.
 
-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
 -----
 
@@ -80,7 +62,7 @@ see the install.txt file in the individual directories:
   docs/msw
   docs/gtk
   docs/motif
-  docs/mac
+  docs/osx
   docs/cocoa
   docs/x11
   docs/mgl
@@ -115,9 +97,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 -
-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.
@@ -142,9 +122,18 @@ See docs/changes.txt for a summary of changes to wxWidgets.
 
 See docs/tech for an archive of technical notes.
 
-The wxWidgets bug database can be browsed at:
+The wxWidgets bug tracker 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.
@@ -169,5 +158,5 @@ web site.
 
 Have fun!
 
-The wxWidgets Team, October 2006
+The wxWidgets Team, January 2007