X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fbdcff4a78e03963d750546b8a74752247b38d40..bb650010c8200174ce824aaadac44e8e5ead194d:/docs/readme.txt diff --git a/docs/readme.txt b/docs/readme.txt index 8d649fd4ca..873ae53805 100644 --- a/docs/readme.txt +++ b/docs/readme.txt @@ -1,135 +1,75 @@ -wxWindows 2.1.14 ----------------- +wxWidgets 2.8.1 +--------------------------------------------------------- -Welcome to wxWindows 2, a sophisticated cross-platform C++ -framework for writing advanced GUI applications using (where -possible) the native controls. +Welcome to wxWidgets, a sophisticated cross-platform C++ +framework for writing advanced GUI applications using +native controls where possible. -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 2000-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 ----------------------- -Please see changes.txt for details. - -Note that there is a new contrib hierarchy for contributions, -which mirrors the regular wxWindows hierarchy. The Object -Graphics Library and MMedia library have been moved under -contrib, so you may need to change your makefiles or project -files, together with your source files. E.g. change #include "ogl.h" -to #include . - -Also VC++ project files and makefiles have been made more -consistent, so some paths and library names have changed. +Please see changes.txt and "Changes since 2.6" in the manual +for details. Platforms supported ------------------- -wxWindows 2 currently supports the following platforms: +wxWidgets currently supports the following platforms: -- Windows 3.1, Windows 95/98, Windows NT +- Windows 95/98/ME, NT, 2000, XP, Vista, Pocket PC/Mobile, Smartphone +- Most Unix variants with GTK+ 1 and GTK+ 2 +- Most Unix variants with X11 (beta) - Most Unix variants with Motif/Lesstif -- Most Unix variants with GTK+ -- Mac (not covered here: please see the wxWindows web site - for details) +- MacOS 9.x and 10.x using Carbon (10.3 and above preferred) +- MacOS 10.x using Cocoa (beta) +- OS/2 (beta) +- PalmOS (alpha) 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.wxwidgets.org/platform.htm. + +Note that 2.6 series were the last to fully support GTK+ 1.2, and Mac OS +9/Mac OS 10.2 and below. wxWidgets 2.7 and above focuses on GTK+ 2 and Mac OS +10.3 and above and compatibility with earlier systems is not guaranteed any +more. 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 -mmedia.zip Optional MMedia class library (Motif, GTK, MSW) -stc.zip Optional wxStyledTextCtrl library (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 --------------------------------- - -wxMotif-2.x.y.tgz wxMotif source distribution. You will - need the HTML and/or PDF documentation - -- OR -- from the zip set (above). - -wx2_x_y_gen.zip -wx2_x_y_mot.zip -jpeg.zip -tiff.zip - -wxWindows for Windows distribution ----------------------------------- - -As well as the core source, the Windows setup contains: - -- Windows Help versions of the documentation (docs/winhelp); -- OGL 3 (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. - -setup.exe Setup file (Windows 95/98, NT) -setup.* Other setup files +The distribution is available in archive formats appropriate to the +target system. See the download pages for details. Installation ------------ -wxWindows 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: +wxWidgets 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: docs/msw docs/gtk docs/motif + docs/mac + docs/cocoa + docs/x11 + docs/mgl + docs/os2 + docs/palmos Licence information ------------------- @@ -143,70 +83,75 @@ 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 -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. - -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. +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 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 carefully LGPL, section +6. which describes conditions for distribution of closed source +applications 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), 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 -the Independent JPEG Group". See src/jpeg/README for 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 ------------- -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 summary of changes to wxWindows 2. +See docs/changes.txt for a summary of changes to wxWidgets. See docs/tech for an archive of technical notes. -The Windows help files are located in docs/winhelp. +The wxWidgets bug database can be browsed at: + + http://sourceforge.net/bugs/?group_id=9863 + +The Windows HTML Help files are located in docs/htmlhelp. +The Windows Help files are located in docs/winhelp. The PDF help files are located in docs/pdf. +The HTB (wxWidgets HTML Help) files are located in docs/htb. Further information ------------------- -The wxWindows Web site is located at: - - http://www.wxwindows.org - -The wxGTK Web site (with further wxGTK-specific files and -information) is located at: +The wxWidgets Web site is located at: - http://www.freiburg.linux.de/~wxxt + 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 -web site) or contact Julian Smart . +material may be ordered from the CD-ROM page: see the wxWidgets +web site. -Good luck! +Have fun! -The wxWindows Team, 19 March, 2000 +The wxWidgets Team, January 2007