fix harmless warnings (mostly about unused parameters/variables)

[wxWidgets.git] / docs / readme.txt

diff --git a/docs/readme.txt b/docs/readme.txt
index d02fd4202581f7343799c48953bddb40bd2b4f46..ee3037773a60a14211ffb6b5a66a564fa5ffb781 100644 (file)
--- a/docs/readme.txt
+++ b/docs/readme.txt
@@ -1,49 +1,46 @@
-wxWidgets 2.5.5
----------------
+wxWidgets 2.9.x
+---------------------------------------------------------

 
 

-*** Please note that this is an UNSTABLE DEVELOPMENT SNAPSHOT.
-*** Unless you need the new features and bug fixes, you may wish to
-*** use the official 2.4.x stable series. You are still encouraged
-*** to try the releases from 2.5.x branch, of course, and unstable
-*** doesn't mean that they crash all the time -- just that the API
-*** may change in a backwards incompatible way. If this doesn't frighten
-*** you, do try this release and please let us know what you think!
-
-Welcome to wxWidgets, a sophisticated cross-platform C++
-framework for writing advanced GUI applications using (where
-possible) the native controls.
+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,
 
 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.
+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 1800-page reference manual is supplied in HTML, PDF
-and Windows Help form: see the docs hierarchy.
+Where certain features are not available on a platform, such
+as MDI under Unix and OS X, they are emulated.

 
 

-For a quick start, point your Web browser at docs/html/index.htm
-for a list of important documents and samples.
+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
 -----------------------
 
 
 Changes in this release
 -----------------------
 

-Please see changes.txt for details.
+Please see changes.txt and "Changes since 2.8" in the manual
+for details.

 
 Platforms supported
 -------------------
 
 wxWidgets currently supports the following platforms:
 
 
 Platforms supported
 -------------------
 
 wxWidgets currently supports the following platforms:
 

-- Windows 95/98/ME, Windows NT, Windows 2000, Windows XP, Pocket PC
-- 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
 - 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)
+- 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.
 
 Most popular C++ compilers are supported; see the install.txt
 file for each platform (available via docs/html/index.htm) for details.


@@ -65,11 +62,12 @@ see the install.txt file in the individual directories:
   docs/msw
   docs/gtk
   docs/motif
   docs/msw
   docs/gtk
   docs/motif

-  docs/mac
+  docs/osx

   docs/cocoa
   docs/x11
   docs/mgl
   docs/os2
   docs/cocoa
   docs/x11
   docs/mgl
   docs/os2

+  docs/palmos

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


@@ -83,35 +81,35 @@ For licensing information, please see the files:
   docs/lgpl.txt
 
 Although this may seem complex, it is there to allow authors of
   docs/lgpl.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 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 carefully LGPL, section 6.
-which describes conditions for distribution of closed source 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.
+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 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 carefully LGPL, section
+6. which describes conditions for distribution of closed source
+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 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.
 

-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 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 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.
 
 
 If you use wxXML classes or XRC, see src/expat/COPYING for licence details.
 


@@ -124,12 +122,23 @@ See docs/changes.txt for a summary of changes to wxWidgets.
 
 See docs/tech for an archive of technical notes.
 
 
 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 help files are located in docs/winhelp.
+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 PDF help files are located in docs/pdf.

+The HTB (wxWidgets HTML Help) files are located in docs/htb.

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


@@ -149,5 +158,5 @@ web site.
 
 Have fun!
 
 
 Have fun!
 

-The wxWidgets Team, February 2005
+The wxWidgets Team, January 2007