X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2c7b88e68c03e3ec2a39ef19c1e69e543fe5b39a..31aa94e3ae3fc7a7547e41c99fe6ec760519d09d:/docs/readme.txt diff --git a/docs/readme.txt b/docs/readme.txt index b9544a6f2d..bc2b34dbc7 100644 --- a/docs/readme.txt +++ b/docs/readme.txt @@ -1,11 +1,15 @@ -wxWindows 2.3.3 +wxWidgets 2.5.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. +*** 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 2, a sophisticated cross-platform C++ +Welcome to wxWidgets, a sophisticated cross-platform C++ framework for writing advanced GUI applications using (where possible) the native controls. @@ -17,7 +21,7 @@ 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 1700-page reference manual is supplied in HTML, PDF +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 @@ -31,114 +35,30 @@ Please see changes.txt for details. Platforms supported ------------------- -wxWindows 2 currently supports the following platforms: +wxWidgets currently supports the following platforms: -- Windows 95/98/ME, Windows NT, Windows 2000, Windows XP (see msw/winxp.txt) -- Most Unix variants with Motif/Lesstif -- Most Unix variants with GTK+ -- MacOS +- Windows 95/98/ME, Windows NT, Windows 2000, Windows XP, Pocket PC +- Most Unix variants with GTK+ 1 and GTK+ 2 - Most Unix variants with X11 (beta) -- DOS with MGL (beta) +- Most Unix variants with Motif/Lesstif +- MacOS 9.x and 10.x using Carbon (10.3 and above preferred) +- MacOS 10.x using Cocoa (beta) +- OS/2 (beta) 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. +See also http://www.wxwidgets.org/platform.htm. Files ----- 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, without - documentation. - -wxWindows for X11 distribution ------------------------------- - -wxX11-x.y.z.tgz wxX11 source distribution, without - 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 +target system. See the download pages for details. Installation ------------ -wxWindows 2 needs to be compiled before you can test out +wxWidgets 2 needs to be compiled before you can test out the samples or write your own applications. For installation information, please see the install.txt file in the individual directories: @@ -149,6 +69,7 @@ in the individual directories: docs/mac docs/x11 docs/mgl + docs/os2 Licence information ------------------- @@ -162,27 +83,27 @@ For licensing information, please see the files: docs/lgpl.txt Although this may seem complex, it is there to allow authors of -proprietary/commercial applications to use wxWindows in +proprietary/commercial applications to use wxWidgets in addition to those writing GPL'ed applications. In summary, 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 wxWidgets. 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. +against LGPL glibc as well. Please read carefully LGPL, section 6. 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). -If compiled with --enable-odbc (Unix only), wxWindows library will +If compiled with --enable-odbc (Unix only), wxWidgets 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. +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 @@ -192,35 +113,41 @@ 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 ------------- 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/changes.txt for a summary of changes to wxWidgets 2. See docs/tech for an archive of technical notes. +The wxWidgets 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. Further information ------------------- -The wxWindows Web site is located at: +The wxWidgets Web site is located at: - http://www.wxwindows.org + http://www.wxwidgets.org -The main wxWindows ftp site is at: +The main wxWidgets 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 +A wxWidgets 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 +material may be ordered from the CD-ROM page: see the wxWidgets web site. Have fun! -The wxWindows Team, 10th June, 2001 +The wxWidgets Team, May 2004