X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0bc9b25e9a0218d5ddc1d12c40dd96216bb275e7..02aa812cb0e5a1ae7fcf827f53f9d41cb0e53c6b:/docs/readme.txt diff --git a/docs/readme.txt b/docs/readme.txt index bcc6c8447f..ee3037773a 100644 --- a/docs/readme.txt +++ b/docs/readme.txt @@ -1,81 +1,73 @@ -wxWindows 2 beta 5 ------------------- +wxWidgets 2.9.x +--------------------------------------------------------- -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 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. -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. -A detailed 700-page reference manual is supplied in HTML, PDF and -Windows Help form. +Where certain features are not available on a platform, such +as MDI under Unix and OS X, they are emulated. -For a quick start, point your Web browser at docs/html/index.htm for a list of -important documents and samples. +A detailed reference manual including in-depth overviews for +various topics is supplied in various formats and can be +accessed online. + +Changes in this release +----------------------- + +Please see changes.txt and "Changes since 2.8" in the manual +for details. Platforms supported ------------------- -wxWindows 2 currently supports the following platforms: +wxWidgets currently supports the following platforms: + +- Windows 95/98/ME, NT, 2000, XP, Vista, Pocket PC/Mobile, Smartphone +- Most Unix variants using the GTK+ 2 toolkit (version 2.4 or newer) +- MacOS OS X (10.4 or newer) using Carbon and some Cocao mix-in + +There is some support for the followig platforms: -- Windows 3.1, Windows 95/98, Windows NT +- Most Unix variants with X11 - Most Unix variants with Motif/Lesstif -- Most Unix variants with GTK+ +- Most Unix variants with GTK+ 1.2 +- MacOS 10.x using the Cocoa API +- OS/2 +- PalmOS -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.wxwidgets.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. 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/osx + docs/cocoa + docs/x11 + docs/mgl + docs/os2 + docs/palmos Licence information ------------------- @@ -89,47 +81,82 @@ 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 L-GPL 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. +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 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 ------------- -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. -The Windows help files are located in docs/winhelp. -The PDF help files are located in docs/pdf. +See docs/changes.txt for a summary of changes to wxWidgets. -Further information -------------------- +See docs/tech for an archive of technical notes. -The wxWindows Web site is located at: +The wxWidgets bug tracker can be browsed at: - http://www.wxwindows.org + http://trac.wxwidgets.org/report -The wxGTK Web site (with further wxGTK-specific files and -information) is located at: +Please use the search function of our Trac installation to find +any possibly relevant bugs before reporting new ones. Also please +notice that often trying to correct the bug yourself is the +quickest way to fix it. Even if you fail to do it, you may +discover valuable information allowing us to fix it while doing +it. We also give much higher priority to bug reports with patches +fixing the problems so this ensures that your report will be +addressed sooner. - http://www.freiburg.linux.de/~wxxt +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 main wxWindows ftp site is at: +The wxWidgets Web site is located at: - ftp://www.remstar.com/pub/wxwin + http://www.wxwidgets.org -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: +The main wxWidgets ftp site is at: - http://www.wxwindows.org/cdrom.htm + ftp://biolpc22.york.ac.uk/pub -or contact Julian Smart . +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 wxWidgets +web site. -Good luck! +Have fun! -The wxWindows Team, February 1999 +The wxWidgets Team, January 2007