X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9a05fd8d137bbe26acd4f86adf6d62c55424822c..5597b61e54211b9e4f21db65da5f83205598615b:/docs/readme.txt diff --git a/docs/readme.txt b/docs/readme.txt index f0037ce8a3..be2fb1c157 100644 --- a/docs/readme.txt +++ b/docs/readme.txt @@ -1,69 +1,132 @@ -wxWindows 2.0 -------------- +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. -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 1400-page reference manual is supplied in HTML, PDF +and Windows Help form: see the docs hierarchy. -A detailed 700-page reference manual is supplied in HTML, PDF and -Windows Help form. +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 +----------------------- + +Please see changes.txt for details. 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+ +- 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 ----- -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/wxgen.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 - -The tarred, gzip archive comprises the following (or similar -names). Not all of these files are available in all distributions, due -to space restrictions. - -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 +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-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-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 MacOS distribution +-------------------------------- + +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; +- a Tex2RTF binary; +- Life! sample binary; +- the JPEG library source; +- the TIFF library source. + +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 ------------ @@ -76,6 +139,7 @@ in the individual directories: docs/msw docs/gtk docs/motif + docs/mac Licence information ------------------- @@ -91,17 +155,43 @@ 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, -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 -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. + +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/changes.txt for a history of changes to wxWindows 2. 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. @@ -123,13 +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: - - http://www.wxwindows.org/cdrom.htm - -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 1999 +The wxWindows Team, 10th June, 2001