]> 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
Some doc changes
[wxWidgets.git] / docs / readme.txt
diff --git a/docs/readme.txt b/docs/readme.txt
index bcc6c8447fa4c5fe0d060a77ef7d78a3ae4de364..616cda1de0063f7be6b1d75b83fe14fe4c974fd4 100644 (file)
--- a/docs/readme.txt
+++ b/docs/readme.txt
@@ -1,23 +1,42 @@
-wxWindows 2 beta 5
-------------------
+wxWindows 2.1.10
+----------------
 
 Welcome to wxWindows 2, a sophisticated cross-platform C++
 framework for writing advanced GUI applications using (where
 possible) the native controls.
 
 In addition to common and advanced GUI facilities such as frames, scrolling
 
 Welcome to wxWindows 2, a sophisticated cross-platform C++
 framework for writing advanced GUI applications using (where
 possible) the 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.
+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.
 
 Where certain features are not available on a platform, such as MDI and
 tree controls on Unix, they are emulated.
 
-A detailed 700-page reference manual is supplied in HTML, PDF and
-Windows Help form.
+A detailed 1100-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.
 
 
 For a quick start, point your Web browser at docs/html/index.htm for a list of
 important documents and samples.
 
+Changes in this release
+-----------------------
+
+These are the major improvements:
+
+wxWindows 2.1.10
+================
+
+- Numerous bug fixes and consistency improvements.
+- Further samples.
+- Factoring out of some code into base classes, for easier
+  maintenance.
+- Integration of wxHTML widget and help controller into
+  wxWindows. wxHTML allows HTML viewing and printing.
+- New classes wxChrono, wxDialUpManager, wxFontEnumerator,
+  wxWizard, etc.
+- wxSocket and wxThread classes rewritten.
+- Documentation improvements.
+
 Platforms supported
 -------------------
 
 Platforms supported
 -------------------
 
@@ -26,6 +45,8 @@ wxWindows 2 currently supports the following platforms:
 - Windows 3.1, Windows 95/98, Windows NT
 - Most Unix variants with Motif/Lesstif
 - Most Unix variants with GTK+
 - Windows 3.1, Windows 95/98, Windows NT
 - Most Unix variants with Motif/Lesstif
 - Most Unix variants with GTK+
+- Mac (not covered here: please see the wxWindows web site
+  for details)
 
 Most popular C++ compilers are supported; see the release notes
 (available via docs/html/index.htm) for details.
 
 Most popular C++ compilers are supported; see the release notes
 (available via docs/html/index.htm) for details.
@@ -33,6 +54,15 @@ Most popular C++ compilers are supported; see the release notes
 Files
 -----
 
 Files
 -----
 
+The distribution is available in a number of formats.
+The most convenient is the platform-specific distribution,
+but the zip set forms a more complete distribution, for example if
+you wish to take part in wxWindows development. Also, add-ons
+such as OGL may only be available in zip form.
+
+Zip set
+-------
+
 Depending on what you downloaded, you may have one or more of
 these ports. You may unarchive any or all of the ports into
 the same directory hierarchy. The zip archive set comprises the
 Depending on what you downloaded, you may have one or more of
 these ports. You may unarchive any or all of the ports into
 the same directory hierarchy. The zip archive set comprises the
@@ -43,7 +73,7 @@ wx200msw.zip            Windows-specific source code
 wx200mot.zip            Motif-specific source code
 wx200gtk.zip            GTK-specific source code
 wx200stubs.zip          Stubs ('empty port') source. Needs
 wx200mot.zip            Motif-specific source code
 wx200gtk.zip            GTK-specific source code
 wx200stubs.zip          Stubs ('empty port') source. Needs
-                        wx200gen.zip/wxgen.tgz.
+                        wx200gen.zip/tgz.
 wx200doc.zip            Documentation source code (not required)
 wx200hlp.zip            WinHelp documentation
 wx200pdf.zip            Acrobat PDF documentation
 wx200doc.zip            Documentation source code (not required)
 wx200hlp.zip            WinHelp documentation
 wx200pdf.zip            Acrobat PDF documentation
@@ -51,19 +81,44 @@ wx200htm.zip            HTML documentation
 wx200vc.zip             MS VC++ 5/6 project files
 wx200bc.zip             Borland C++ 5 project files
 wx200cw.zip             Metrowerks CodeWarrior 4.1 project files
 wx200vc.zip             MS VC++ 5/6 project files
 wx200bc.zip             Borland C++ 5 project files
 wx200cw.zip             Metrowerks CodeWarrior 4.1 project files
+jpeg.zip                Optional JPEG library
+ogl3.zip                Optional Object Graphics Library
+glcanvas.zip            Optional wxGLCanvas class (Motif, GTK, MSW)
+tex2rtf2.zip            Tex2RTF documentation tool
+
+wxWindows for GTK distribution
+------------------------------
+
+wxGTK-2.x.x.tgz         wxGTK source distribution. You will
+                        need the HTML and/or PDF documentation
+                        from the zip set (above).
 
 
-The tarred, gzip archive comprises the following (or similar
-names). Not all of these files are available in all distributions, due
-to space restrictions.
+wxWindows for Motif distribution
+--------------------------------
 
 
-wxgtk.tgz               All wxGTK source and samples
-wxmotif.tgz             All wxMotif source and samples
-wxstubs.tgz             Stubs ('empty port') source. Needs
-                        wx200gen.zip/wxgen.tgz.
-wxgen.tgz               Generic code and samples (common to all ports)
-wxpdf.tgz               Acrobat PDF documentation
-wxhtml.tgz              HTML documentation
-wxdocsrc.tgz            Documentation source
+wxMotif-2.x.x.tgz       wxMotif source distribution. You will
+                        need the HTML and/or PDF documentation
+   -- OR --             from the zip set (above).
+
+wx200gen.zip
+wx200msw.zip
+wx200mot.zip
+jpeg.zip
+
+wxWindows for Windows distribution
+----------------------------------
+
+As well as the core source, the Windows setup contains:
+
+- Windows Help versions of the documentation (docs/winhelp);
+- wxGLCanvas (OpenGL integration, in utils/glcanvas);
+- OGL 3 (Object Graphics Library, in utils/ogl);
+- wxTreeLayout (for tree drawing, in utils/wxtree);
+- a Dialog Editor binary;
+- the JPEG library.
+
+setup.exe               Setup file (Windows 95/98, NT)
+setup.*                 Other setup files
 
 Installation
 ------------
 
 Installation
 ------------
@@ -99,7 +154,7 @@ commercial applications using wxWindows.
 Documentation
 -------------
 
 Documentation
 -------------
 
-See docs/changes.txt for a history of changes to wxWindows 2.
+See docs/changes.txt for a detailed history of changes to wxWindows 2.
 See docs/html/index.htm for an HTML index of the major documents.
 
 The Windows help files are located in docs/winhelp.
 See docs/html/index.htm for an HTML index of the major documents.
 
 The Windows help files are located in docs/winhelp.
@@ -123,13 +178,10 @@ The main wxWindows ftp site is at:
 
 A wxWindows CD-ROM with the latest distribution plus an HTML
 front-end and hundreds of MB of compilers, utilities and other
 
 A wxWindows 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:
-
-  http://www.wxwindows.org/cdrom.htm
-
-or contact Julian Smart <julian.smart@ukonline.co.uk>.
+material may be ordered from the CD-ROM page (see the wxWindows
+web site) or contact Julian Smart <julian.smart@ukonline.co.uk>.
 
 Good luck!
 
 
 Good luck!
 
-The wxWindows Team, February 1999
+The wxWindows Team, November 1999
 
 
wxWidgets (Impactor)