docs/readme.txt

   1 wxWindows 2 beta 5
   2 ------------------
   3
   4 Welcome to wxWindows 2, a sophisticated cross-platform C++
   5 framework for writing advanced GUI applications using (where
   6 possible) the native controls.
   7
   8 In addition to common and advanced GUI facilities such as frames, scrolling
   9 windows, toolbars, tree controls, icons, device contexts,
  10 printing, splitter windows and so on, there are wrappers for common
  11 file operations and facilities for writing TCP/IP applications.
  12 Where certain features are not available on a platform, such as MDI and
  13 tree controls on Unix, they are emulated.
  14
  15 A detailed 700-page reference manual is supplied in HTML, PDF and
  16 Windows Help form.
  17
  18 For a quick start, point your Web browser at docs/html/index.htm for a list of
  19 important documents and samples.
  20
  21 Platforms supported
  22 -------------------
  23
  24 wxWindows 2 currently supports the following platforms:
  25
  26 - Windows 3.1, Windows 95/98, Windows NT
  27 - Most Unix variants with Motif/Lesstif
  28 - Most Unix variants with GTK+
  29
  30 Most popular C++ compilers are supported; see the release notes
  31 (available via docs/html/index.htm) for details.
  32
  33 Files
  34 -----
  35
  36 Depending on what you downloaded, you may have one or more of
  37 these ports. You may unarchive any or all of the ports into
  38 the same directory hierarchy. The zip archive set comprises the
  39 following:
  40
  41 wx200gen.zip            Generic source code and samples (required)
  42 wx200msw.zip            Windows-specific source code
  43 wx200mot.zip            Motif-specific source code
  44 wx200gtk.zip            GTK-specific source code
  45 wx200stubs.zip          Stubs ('empty port') source. Needs
  46                         wx200gen.zip/wxgen.tgz.
  47 wx200doc.zip            Documentation source code (not required)
  48 wx200hlp.zip            WinHelp documentation
  49 wx200pdf.zip            Acrobat PDF documentation
  50 wx200htm.zip            HTML documentation
  51 wx200vc.zip             MS VC++ 5/6 project files
  52 wx200bc.zip             Borland C++ 5 project files
  53 wx200cw.zip             Metrowerks CodeWarrior 4.1 project files
  54
  55 The tarred, gzip archive comprises the following (or similar
  56 names). Not all of these files are available in all distributions, due
  57 to space restrictions.
  58
  59 wxgtk.tgz               All wxGTK source and samples
  60 wxmotif.tgz             All wxMotif source and samples
  61 wxstubs.tgz             Stubs ('empty port') source. Needs
  62                         wx200gen.zip/wxgen.tgz.
  63 wxgen.tgz               Generic code and samples (common to all ports)
  64 wxpdf.tgz               Acrobat PDF documentation
  65 wxhtml.tgz              HTML documentation
  66 wxdocsrc.tgz            Documentation source
  67
  68 Installation
  69 ------------
  70
  71 wxWindows 2 needs to be compiled before you can test out
  72 the samples or write your own applications.
  73 For installation information, please see the install.txt file
  74 in the individual directories:
  75
  76   docs/msw
  77   docs/gtk
  78   docs/motif
  79
  80 Licence information
  81 -------------------
  82
  83 For licensing information, please see the files:
  84
  85   docs/preamble.txt
  86   docs/licence.txt
  87   docs/licendoc.txt
  88   docs/gpl.txt
  89   docs/lgpl.txt
  90
  91 Although this may seem complex, it is there to allow authors of
  92 proprietary/commercial applications to use wxWindows in
  93 addition to those writing GPL'ed applications. In summary,
  94 the licence is L-GPL plus a clause allowing unrestricted
  95 distribution of application binaries. To answer a FAQ, you
  96 don't have to distribute any source if you wish to write
  97 commercial applications using wxWindows.
  98
  99 Documentation
 100 -------------
 101
 102 See docs/changes.txt for a history of changes to wxWindows 2.
 103 See docs/html/index.htm for an HTML index of the major documents.
 104
 105 The Windows help files are located in docs/winhelp.
 106 The PDF help files are located in docs/pdf.
 107
 108 Further information
 109 -------------------
 110
 111 The wxWindows Web site is located at:
 112
 113   http://www.wxwindows.org
 114
 115 The wxGTK Web site (with further wxGTK-specific files and
 116 information) is located at:
 117
 118   http://www.freiburg.linux.de/~wxxt
 119
 120 The main wxWindows ftp site is at:
 121
 122   ftp://www.remstar.com/pub/wxwin
 123
 124 A wxWindows CD-ROM with the latest distribution plus an HTML
 125 front-end and hundreds of MB of compilers, utilities and other
 126 material may be ordered from the CD-ROM page:
 127
 128   http://www.wxwindows.org/cdrom.htm
 129
 130 or contact Julian Smart <julian.smart@ukonline.co.uk>.
 131
 132 Good luck!
 133
 134 The wxWindows Team, February 1999
 135