X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9bb3479c68dd8e6cde9c997f4221fc5cfc5ca110..51dc95a4c8ccb00741be48f6353749ada3e9f39a:/docs/readme.txt?ds=inline diff --git a/docs/readme.txt b/docs/readme.txt index b2dbdf19e8..be2fb1c157 100644 --- a/docs/readme.txt +++ b/docs/readme.txt @@ -1,22 +1,27 @@ -wxWindows 2.1.13 ----------------- +wxWindows 2.3.2 +--------------- + +*** 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.2.x stable series. 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, 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 1400-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 ----------------------- @@ -28,83 +33,100 @@ Platforms supported wxWindows 2 currently supports the following platforms: -- Windows 3.1, Windows 95/98, Windows NT +- Windows 3.1, Windows 95/98, Windows NT, Windows 2000 - Most Unix variants with Motif/Lesstif - Most Unix variants with GTK+ -- Mac (not covered here: please see the wxWindows web site - for details) +- MacOS 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 ----- -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 +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 ------------------------------ -wxGTK-2.x.y.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 -------------------------------- -wxMotif-2.x.y.tgz wxMotif source distribution. You will - need the HTML and/or PDF documentation - -- OR -- from the zip set (above). +wxMotif-x.y.z.tgz wxMotif source distribution. Contains + TIFF, JPEG, Tex2RTF source plus HTML + documentation. -wx2_x_y_gen.zip -wx2_x_y_mot.zip -jpeg.zip +wxWindows for MS Windows distribution +------------------------------------- -wxWindows for 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 -As well as the core source, the Windows setup contains: +wxWindows for MacOS 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); +wxMac-x.y.z.zip Zip archive containing all + source files (excludes documentation) + +As well as the core source, the wxMSW distribution contains: + +- Windows HTML Help versions of the documentation (docs/htmlhelp); +- Object Graphics Library, in contrib/src/ogl; - 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-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 +------- + +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 ------------ @@ -117,6 +139,7 @@ in the individual directories: docs/msw docs/gtk docs/motif + docs/mac Licence information ------------------- @@ -146,20 +169,28 @@ 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. + +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. + Documentation ------------- -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/changes.txt for a detailed history of changes to wxWindows 2 - (not up-to-date). +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. @@ -182,10 +213,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 -material may be ordered from the CD-ROM page (see the wxWindows -web site) or contact Julian Smart . +material may be ordered from the CD-ROM page: see the wxWindows +web site. -Good luck! +Have fun! -The wxWindows Team, February 2000 +The wxWindows Team, 10th June, 2001