docs/readme.txt

   1 wxWindows 2 beta 3
   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 wx200doc.zip            Documentation source code (not required)
  46 wx200hlp.zip            WinHelp documentation
  47 wx200pdf.zip            Acrobat PDF documentation
  48 wx200htm.zip            HTML documentation
  49 wx200vc.zip             MS VC++ 5.0 project files
  50 wx200cw.zip             Metrowerks CodeWarrior project files
  51
  52 Installation
  53 ------------
  54
  55 wxWindows 2 needs to be compiled before you can test out
  56 the samples or write your own applications.
  57 For installation information, please see the install.txt file
  58 in the individual directories:
  59
  60   docs/msw
  61   docs/gtk
  62   docs/motif
  63
  64 Licence information
  65 -------------------
  66
  67 For licensing information, please see the files:
  68
  69   docs/preamble.txt
  70   docs/licence.txt
  71   docs/licendoc.txt
  72   docs/gpl.txt
  73   docs/lgpl.txt
  74
  75 Although this may seem complex, it is there to allow authors of
  76 proprietary/commercial applications to use wxWindows in
  77 addition to those writing GPL'ed applications. In summary,
  78 the licence is L-GPL plus a clause allowing unrestricted
  79 distribution of application binaries. To answer a FAQ, you
  80 don't have to distribute any source if you wish to write
  81 commercial applications using wxWindows.
  82
  83 Documentation
  84 -------------
  85
  86 See docs/changes.txt for a history of changes to wxWindows 2.
  87 See docs/html/index.htm for an HTML index of the major documents.
  88
  89 The Windows help files are located in docs/winhelp.
  90 The PDF help files are located in docs/pdf.
  91
  92 Further information
  93 -------------------
  94
  95 The wxWindows Web site is located at:
  96
  97   http://www.wxwindows.org
  98
  99 The wxGTK Web site (with further wxGTK-specific fiels and
 100 information) is located at:
 101
 102   http://www.freiburg.linux.de/~wxxt
 103
 104 The main wxWindows ftp site is at:
 105
 106   ftp://www.remstar.com/pub/wxwin
 107
 108 A wxWindows CD-ROM with the latest distribution plus an HTML
 109 front-end and hundreds of MB of compilers, utilities and other
 110 material may be ordered from the CD-ROM page:
 111
 112   http://www.wxwindows.org/cdrom.htm
 113
 114 or contact Julian Smart <julian.smart@ukonline.co.uk>.
 115
 116 Good luck!
 117
 118 The wxWindows Team, January 1999
 119