]> 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
More lib and demo changes for dropping the wx prefix, from Jeff G.
[wxWidgets.git] / docs / readme.txt
diff --git a/docs/readme.txt b/docs/readme.txt
index 9562855457f0a1092c95a7189717978a046042a0..03bbb233350357b3691c6a3141922013de2935bf 100644 (file)
--- a/docs/readme.txt
+++ b/docs/readme.txt
@@ -1,149 +1,120 @@
-wxWindows 2.1.12
-----------------
-
-Welcome to wxWindows 2, a sophisticated cross-platform C++
+wxWindows 2.5.1
+---------------
+
+*** 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++
 framework for writing advanced GUI applications using (where
 possible) the native controls.
 
 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, thread handling, and more.
-Where certain features are not available on a platform, such as MDI and
-tree controls on Unix, they are emulated.
+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 1100-page reference manual is supplied in HTML, PDF and
-Windows Help form: see the docs hierarchy.
+A detailed 1800-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
 -----------------------
 
 
 Changes in this release
 -----------------------
 
-These are some of the major improvements:
-
-wxWindows 2.1.12
-================
-
-- New wxDateTime class to replace millenium-uncompliant wxTime
-  and wxDate classes.
-- New wxCalendarCtrl class and sample.
-- New wxCmdLineParser class.
-- Further bug fixes.
-- TIFF support added to wxImage.
-
-wxWindows 2.1.11
-================
-
-- Numerous bug fixes and consistency improvements.
-- Further samples.
-- Factoring out of some code into base classes, for easier
-  maintenance.
-- Ability to compile library in console (non-GUI) mode.
-- Integration of wxHTML widget and help controller into
-  wxWindows. wxHTML allows HTML viewing and printing (wxGTK
-  and wxMSW, partial support in wxMotif).
-- New classes wxChrono, wxDialUpManager, wxFontEnumerator,
-  wxWizard, wxStaticLine, etc.
-- wxShowTip for showing 'startup tips' to the user.
-- wxSocket and wxThread classes rewritten.
-- New, consistent drag and drop API (not wxMotif).
-- Better-looking dialogs in wxGTK; native message box used
-  in wxMotif.
-- wxSizers reimplemented and used to specify window layout
-  for some generic dialogs.
-- New, more sophisticated wxGrid class (in beta). The old grid
-  class can still be used.
-- Text alignment options in wxStaticText.
-- wxImage class extended to read PCX and GIF files.
-- Documentation improvements.
-- Revised configure system for wxGTK and wxMotif; tmake-based
-  system for generating wxMSW makefiles.
-- Installer for Windows as alternative to zip archives.
+Please see changes.txt for details.
 
 Platforms supported
 -------------------
 
 
 Platforms supported
 -------------------
 
-wxWindows 2 currently supports the following platforms:
+wxWindows currently supports the following platforms:
 
 
-- Windows 3.1, Windows 95/98, Windows NT
-- Most Unix variants with Motif/Lesstif
+- Windows 95/98/ME, Windows NT, Windows 2000, Windows XP
 - Most Unix variants with GTK+
 - Most Unix variants with GTK+
-- Mac (not covered here: please see the wxWindows web site
-  for details)
+- Most Unix variants with X11
+- Most Unix variants with Motif/Lesstif
+- MacOS 9.x and 10.x
+- OS/2 (alpha)
 
 
-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, where x is the minor version and y the release number:
-
-wx2_x_y_gen.zip            Generic source code and samples (required)
-wx2_x_y_msw.zip            Windows-specific source code
-wx2_x_y_mot.zip            Motif-specific source code
-wx2_x_y_gtk.zip            GTK-specific source code
-wx2_x_y_stubs.zip          Stubs ('empty port') source. Needs
-                           wx2_x_y_gen.zip/tgz.
-wx2_x_y_doc.zip            Documentation source code (not required)
-wx2_x_y_hlp.zip            WinHelp documentation
-wx2_x_y_pdf.zip            Acrobat PDF documentation
-wx2_x_y_htm.zip            HTML documentation
-wx2_x_y_vc.zip             MS VC++ 5/6 project files
-wx2_x_y_bc.zip             Borland C++ 5 project files
-wx2_x_y_cw.zip             Metrowerks CodeWarrior 4.1 project files
-jpeg.zip                   Optional JPEG library
-tiff.zip                   Optional TIFF 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.y.tgz            wxGTK source distribution. You will
-                           need the HTML and/or PDF documentation
-                           from the zip set (above).
-
-wxWindows for Motif distribution
---------------------------------
+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
 
 
-wxMotif-2.x.y.tgz          wxMotif source distribution. You will
-                           need the HTML and/or PDF documentation
-   -- OR --                from the zip set (above).
+wxWindows for X11 and Motif distribution
+----------------------------------------
 
 
-wx2_x_y_gen.zip
-wx2_x_y_mot.zip
-jpeg.zip
+wxX11-x.y.z.tar.gz                 wxX11 and wxMotif source distribution, without
+                                   documentation.
 
 
-wxWindows for Windows distribution
-----------------------------------
+wxWindows for MS Windows distribution
+-------------------------------------
 
 
-As well as the core source, the Windows setup contains:
+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
 
 
-- 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);
+As well as the core source, the wxMSW distribution contains:
+
+- Windows HTML Help versions of the documentation (docs/htmlhelp);
 - a Dialog Editor binary;
 - a Dialog Editor binary;
-- the JPEG library.
+- 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)
 
 
-setup.exe               Setup file (Windows 95/98, NT)
-setup.*                 Other setup files
+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)
 
 Installation
 ------------
 
 Installation
 ------------
@@ -156,6 +127,10 @@ in the individual directories:
   docs/msw
   docs/gtk
   docs/motif
   docs/msw
   docs/gtk
   docs/motif
+  docs/mac
+  docs/x11
+  docs/mgl
+  docs/os2
 
 Licence information
 -------------------
 
 Licence information
 -------------------
@@ -180,28 +155,40 @@ 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
 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.
+against LGPL glibc as well. Please read carefully LGPL, section 6.
 which describes conditions for distribution of closed source applications
 which describes conditions for distribution of closed source applications
-linked against LGPL library. Basically you should link dynamicaly and
+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).
 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 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 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 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.
+
 
 Documentation
 -------------
 
 
 Documentation
 -------------
 
-See docs/release.txt for some notes about the current release.
+See docs/html/index.htm for an HTML index of the major documents.
 
 
-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/changes.txt for a summary of changes to wxWindows 2.
 
 
-See docs/html/index.htm for an HTML index of the major documents.
+See docs/tech for an archive of technical notes.
 
 
-See docs/changes.txt for a detailed history of changes to wxWindows 2
-  (not up-to-date).
+The wxWindows bug database can be browsed at:
+
+  http://sourceforge.net/bugs/?group_id=9863
 
 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.
@@ -213,21 +200,16 @@ The wxWindows Web site is located at:
 
   http://www.wxwindows.org
 
 
   http://www.wxwindows.org
 
-The wxGTK Web site (with further wxGTK-specific files and
-information) is located at:
-
-  http://www.freiburg.linux.de/~wxxt
-
 The main wxWindows ftp site is at:
 
 The main wxWindows ftp site is at:
 
-  ftp://www.remstar.com/pub/wxwin
+  ftp://biolpc22.york.ac.uk/pub
 
 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!
+Have fun!
 
 
-The wxWindows Team, Janurary 2000
+The wxWindows Team, September 2003
 
 
wxWidgets (Impactor)