]> 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
Added "set new icon" menu item to taskbar sample; updated some makefiles
[wxWidgets.git] / docs / readme.txt
diff --git a/docs/readme.txt b/docs/readme.txt
index 89d7f72af9510f2416b38c7cccc378ce7d100dec..49c7f3105d53120d3f01b599306cf78494221a00 100644 (file)
--- a/docs/readme.txt
+++ b/docs/readme.txt
@@ -1,5 +1,5 @@
-wxWindows 2.1
--------------
+wxWindows 2.3.0
+---------------
 
 Welcome to wxWindows 2, a sophisticated cross-platform C++
 framework for writing advanced GUI applications using (where
 
 Welcome to wxWindows 2, a sophisticated cross-platform C++
 framework for writing advanced GUI applications using (where
@@ -12,26 +12,16 @@ 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 1100-page reference manual is supplied in HTML, PDF and
+A detailed 1400-page reference manual is supplied in HTML, PDF and
 Windows Help form: see the docs hierarchy.
 
 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
 -----------------------
 
 
 Changes in this release
 -----------------------
 
-These are the major improvements:
-
-wxWindows 2.1
-=============
-
-- Integration of wxHTML widget and help controller into
-  wxWindows. wxHTML allows HTML viewing and printing.
-- New classes wxChrono, wxDialUpManager, wxFontEnumerator,
-  TODO
-- wxSocket and wxThread classes rewritten.
-- Documentation improvements.
+Please see changes.txt for details.
 
 Platforms supported
 -------------------
 
 Platforms supported
 -------------------
@@ -41,78 +31,97 @@ 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+
+- MacOS
 
 
-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 install.txt
+file for each platform (available via docs/html/index.htm) for details.
+See also http://www.wxwindows.org/platform.htm.
 
 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
-following:
-
-wx200gen.zip            Generic source code and samples (required)
-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
-                        wx200gen.zip/tgz.
-wx200doc.zip            Documentation source code (not required)
-wx200hlp.zip            WinHelp documentation
-wx200pdf.zip            Acrobat PDF documentation
-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
-jpeg.zip                Optional JPEG library
-ogl3.zip                Optional Object Graphics Library
-glcanvas.zip            Optional wxGLCanvas class (Motif, GTK, MSW)
-tex2rtf2.zip            Tex2RTF documentation tool
+The distribution is available in archive formats appropriate to the
+target system. Documentation is available mainly in zip format.
+Some add-on libraries (such as the Object Graphics Library) are
+available in zip form only. In the following, x.y.z represents
+the current version number.
 
 wxWindows for GTK distribution
 ------------------------------
 
 
 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).
+wxGTK-x.y.z.tgz                    wxGTK source distribution. You will
+                                   need the HTML, HTB and/or PDF documentation
+                                   (see below)
+wxGTK-demos-x.y.z.tgz              wxGTK demos source
+wxGTK-samples-x.y.z.tgz            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
 
 wxWindows for Motif distribution
 --------------------------------
 
 
 wxWindows for Motif distribution
 --------------------------------
 
-wxMotif-2.x.x.tgz       wxMotif source distribution. You will
-                        need the HTML and/or PDF documentation
-                        from the zip set (above).
+wxMotif-x.y.z.tgz                  wxMotif source distribution. Contains
+                                   TIFF, JPEG, Tex2RTF source plus HTML
+                                   documentation.
+
+wxWindows for MS Windows distribution
+-------------------------------------
+
+setup.exe, setup.w*                Setup files (Windows 95/98, NT)
+                                   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
 
 
-wxWindows for Windows distribution
-----------------------------------
+wxWindows for MacOS distribution
+--------------------------------
+
+wxMac-x.y.z.zip                    Zip archive containing all
+                                   source files (excludes documentation)
 
 
-As well as the core source, the Windows setup contains:
+As well as the core source, the wxMSW distribution 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);
+- Windows HTML Help versions of the documentation (docs/htmlhelp);
+- Object Graphics Library, in contrib/src/ogl;
 - a Dialog Editor binary;
 - a Dialog Editor binary;
-- the JPEG library.
+- a Tex2RTF binary;
+- Life! sample binary;
+- the JPEG library source;
+- the TIFF library source.
 
 
-setup.exe               Setup file (Windows 95/98, NT)
-setup.*                 Other setup files
+Documentation files
+-------------------
 
 
-wxWindows for Mac distribution
-------------------------------
+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)
+wxWindows-x.y.z-Word.zip           MS Word documentation (currently,
+                                   database class documentation only)
+wxWindows-x.y.z-DocSource.zip      Documentation source code (not required)
+
+Add-ons
+-------
 
 
-TODO
+wxWindows-x.y.z-cw.zip             Metrowerks CodeWarrior 4.1 project files
+wxWindows-x.y.z-wat.zip            Watcom C++ project files
+wxWindows-x.y.z-vc.zip             Visual C++ project files (in wxMSW distr.)
+wxWindows-x.y.z-bc.zip             Borland C++ project files (in wxMSW distr.)
+jpeg.zip                           JPEG library (already included
+                                   in most distributions)
+tiff.zip                           TIFF library (already included
+                                   in most distributions)
+ogl3.zip                           Optional Object Graphics Library
+mmedia.zip                         Optional MMedia library (Motif, GTK, MSW)
+stc.zip                            Optional wxStyledTextCtrl library
+                                   (Motif, GTK, MSW)
+tex2rtf2.zip                       Tex2RTF documentation tool
+wxGTK-gl-x.y.z-0.i386.rpm          add-on OpenGL binary as an RPM
 
 Installation
 ------------
 
 Installation
 ------------
@@ -125,6 +134,7 @@ in the individual directories:
   docs/msw
   docs/gtk
   docs/motif
   docs/msw
   docs/gtk
   docs/motif
+  docs/mac
 
 Licence information
 -------------------
 
 Licence information
 -------------------
@@ -140,17 +150,42 @@ For licensing information, please see the files:
 Although this may seem complex, it is there to allow authors of
 proprietary/commercial applications to use wxWindows in
 addition to those writing GPL'ed applications. In summary,
 Although this may seem complex, it is there to allow authors of
 proprietary/commercial applications to use wxWindows in
 addition to those writing GPL'ed applications. In summary,
-the licence is L-GPL plus a clause allowing unrestricted
+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
 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 wxWindows. 
+
+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 carefuly LGPL, section 6.
+which describes conditions for distribution of closed source applications
+linked against LGPL library. Basically you should link dynamicaly 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 
+contain iODBC library which is covered by LGPL.
+
+If you use TIFF image handler, please see src/tiff/COPYRIGHT
+for libtiff license 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.
 
 Documentation
 -------------
 
 
 Documentation
 -------------
 
-See docs/changes.txt for a detailed history of changes to wxWindows 2.
+See docs/bugs.txt for a bug list: this file is new and will initially
+  be edited by hand, later generated from a web-based bug database.
+
 See docs/html/index.htm for an HTML index of the major documents.
 
 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/tech for an archive of technical notes.
+
 The Windows help files are located in docs/winhelp.
 The PDF help files are located in docs/pdf.
 
 The Windows help files are located in docs/winhelp.
 The PDF help files are located in docs/pdf.
 
@@ -172,10 +207,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 (see the wxWindows
-web site) or contact Julian Smart <julian.smart@ukonline.co.uk>.
+material may be ordered from the CD-ROM page: see the wxWindows
+web site.
 
 Good luck!
 
 
 Good luck!
 
-The wxWindows Team, November 1999
+The wxWindows Team, 8th May, 2001
 
 
wxWidgets (Impactor)