]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/readme.txt
Typo
[wxWidgets.git] / docs / readme.txt
index e0b8fccba2766a4989bbe1b9433273815a4ae49f..775cf20b5e0ebbd9ec15665ae9ea9599717bc866 100644 (file)
@@ -1,15 +1,7 @@
-wxWindows 2.5.1
+wxWidgets 2.6.0
 ---------------
 
-*** 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 backwards incompatible way. If this doesn't frighten
-*** you, do try this release and please let us know what you think!
-
-Welcome to wxWindows, a sophisticated cross-platform C++
+Welcome to wxWidgets, a sophisticated cross-platform C++
 framework for writing advanced GUI applications using (where
 possible) the native controls.
 
@@ -21,7 +13,7 @@ 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 1800-page reference manual is supplied in HTML, PDF
+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
@@ -35,98 +27,38 @@ Please see changes.txt for details.
 Platforms supported
 -------------------
 
-wxWindows currently supports the following platforms:
+wxWidgets currently supports the following platforms:
 
-- Windows 95/98/ME, Windows NT, Windows 2000, Windows XP
-- Most Unix variants with GTK+
-- Most Unix variants with X11
+- 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)
 - Most Unix variants with Motif/Lesstif
-- MacOS 9.x and 10.x
-- OS/2 (alpha)
+- MacOS 9.x and 10.x using Carbon (10.3 and above preferred)
+- MacOS 10.x using Cocoa (beta)
+- OS/2 (beta)
 
 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.wxwindows.org/platform.htm.
+See also http://www.wxwidgets.org/platform.htm.
 
 Files
 -----
 
 The distribution is available in archive formats appropriate to the
-target system. Documentation is available mainly in zip format.
-In the following, x.y.z represents the current version number.
-
-wxWindows for GTK+ distribution
--------------------------------
-
-wxGTK-x.y.z.tar.gz                 wxGTK source distribution. You will
-                                   need the HTML, HTB and/or PDF documentation
-                                   (see below)
-wxGTK-demos-x.y.z.tar.gz           wxGTK demos source
-wxGTK-samples-x.y.z.tar.gz         wxGTK samples source
-wxGTK-x.y.z-0.src.rpm              wxGTK Linux source as an RPM, without manuals
-wxGTK-x.y.z-0.i386.rpm             wxGTK Linux binaries as an RPM, without manuals
-wxGTK-devel-x.y.z-0.i386.rpm       wxGTK Linux minimum development system as an RPM
-wxGTK-gl-x.y.z-0.i386.rpm          Add-on OpenGL binary as an RPM
-
-wxWindows for X11 and Motif distribution
-----------------------------------------
-
-wxX11-x.y.z.tar.gz                 wxX11 and wxMotif source distribution, without
-                                   documentation.
-
-wxWindows for MS Windows distribution
--------------------------------------
-
-setup.exe, setup-*.bin             Setup files in floppy-disk-sized chunks
-wxMSW-x.y.z-setup.zip              Zip archive containing the
-                                   setup files
-wxMSW-x.y.z.zip                    Zip archive containing all the files that are
-                                   in the setup distribution
-
-As well as the core source, the wxMSW distribution contains:
-
-- Windows HTML Help versions of the documentation (docs/htmlhelp);
-- a Tex2RTF binary;
-- Life! sample binary.
-
-wxWindows for MacOS distribution
---------------------------------
-
-wxMac-x.y.z.zip                    Zip archive containing all
-                                   source files (excludes documentation)
-wxMac-x.y.z.tar.gz                 Gzipped tar archive containing all
-                                   source files (excludes documentation).
-                                   You might prefer this format if building on
-                                   MacOS X, since it preserves file permissions.
-
-wxWindows for OS/2 distribution
--------------------------------
-
-wxOS2-x.y.z.zip                    Zip archive containing all source files
-                                   (excludes documentation)
-
-Documentation files
--------------------
-
-wxWindows-x.y.z-WinHelp.zip        WinHelp documentation
-wxWindows-x.y.z-PDF.zip            Acrobat PDF documentation
-wxWindows-x.y.z-HTML.zip           HTML documentation
-wxWindows-x.y.z-HTMLHelp.zip       Windows HTML Help documentation
-wxWindows-x.y.z-HTB.zip            wxHTML documentation (for
-                                   use with the helpview utility)
+target system. See the download pages for details.
 
 Installation
 ------------
 
-wxWindows 2 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:
+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
@@ -143,12 +75,12 @@ For licensing information, please see the files:
   docs/lgpl.txt
 
 Although this may seem complex, it is there to allow authors of
-proprietary/commercial applications to use wxWindows in
+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 wxWindows. 
+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
@@ -159,7 +91,7 @@ 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), wxWindows library will 
+If compiled with --enable-odbc (Unix only), wxWidgets library will 
 contain iODBC library which is covered by LGPL.
 
 If you use TIFF image handler, please see src/tiff/COPYRIGHT
@@ -175,17 +107,16 @@ regular expression library copyright.
 
 If you use wxXML classes or XRC, see src/expat/COPYING for licence details.
 
-
 Documentation
 -------------
 
 See docs/html/index.htm for an HTML index of the major documents.
 
-See docs/changes.txt for a summary of changes to wxWindows 2.
+See docs/changes.txt for a summary of changes to wxWidgets.
 
 See docs/tech for an archive of technical notes.
 
-The wxWindows bug database can be browsed at:
+The wxWidgets bug database can be browsed at:
 
   http://sourceforge.net/bugs/?group_id=9863
 
@@ -195,20 +126,20 @@ The PDF help files are located in docs/pdf.
 Further information
 -------------------
 
-The wxWindows Web site is located at:
+The wxWidgets Web site is located at:
 
-  http://www.wxwindows.org
+  http://www.wxwidgets.org
 
-The main wxWindows ftp site is at:
+The main wxWidgets ftp site is at:
 
   ftp://biolpc22.york.ac.uk/pub
 
-A wxWindows CD-ROM with the latest distribution plus an HTML
+A wxWidgets CD-ROM with the latest distribution plus an HTML
 front-end and hundreds of MB of compilers, utilities and other
-material may be ordered from the CD-ROM page: see the wxWindows
+material may be ordered from the CD-ROM page: see the wxWidgets
 web site.
 
 Have fun!
 
-The wxWindows Team, February 2004
+The wxWidgets Team, April 2005