X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/38d24a39d3269c5b595ec313475c2fb04ac9a353..623e1cb20931785d5f3a12de547fb28e0135f7fc:/docs/readme.txt

diff --git a/docs/readme.txt b/docs/readme.txt
index 9c8558891a..bcc6c8447f 100644
--- a/docs/readme.txt
+++ b/docs/readme.txt
@@ -1,13 +1,135 @@
-wxWindows 2.0 alpha
+wxWindows 2 beta 5
+------------------
+
+Welcome to wxWindows 2, a sophisticated cross-platform C++
+framework for writing advanced GUI applications using (where
+possible) the native controls.
+
+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.
+
+A detailed 700-page reference manual is supplied in HTML, PDF and
+Windows Help form.
+
+For a quick start, point your Web browser at docs/html/index.htm for a list of
+important documents and samples.
+
+Platforms supported
 -------------------
 
-This is an alpha distribution of wxWindows 2.0. It may be made up
-of sources for different platforms from different authors.
+wxWindows 2 currently supports the following platforms:
+
+- Windows 3.1, Windows 95/98, Windows NT
+- Most Unix variants with Motif/Lesstif
+- Most Unix variants with GTK+
+
+Most popular C++ compilers are supported; see the release notes
+(available via docs/html/index.htm) for details.
+
+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:
 
-For generic installation information, see the docs directory. For
-platform-specific installation information see:
+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
+
+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:
 
   docs/msw
   docs/gtk
   docs/motif
 
+Licence information
+-------------------
+
+For licensing information, please see the files:
+
+  docs/preamble.txt
+  docs/licence.txt
+  docs/licendoc.txt
+  docs/gpl.txt
+  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.
+
+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.
+
+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:
+
+  http://www.freiburg.linux.de/~wxxt
+
+The main wxWindows ftp site is at:
+
+  ftp://www.remstar.com/pub/wxwin
+
+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:
+
+  http://www.wxwindows.org/cdrom.htm
+
+or contact Julian Smart <julian.smart@ukonline.co.uk>.
+
+Good luck!
+
+The wxWindows Team, February 1999
+