README

   1 README for MinGW Windows ToolKit
   2 ================================
   3
   4 $Id$
   5
   6 Written by Keith Marshall <keithmarshall@users.sourceforge.net>
   7 Copyright (C) 2012, MinGW.org Project
   8
   9
  10 Synopsis
  11 --------
  12
  13 This package implements a minimal C++ class framework, encapsulating
  14 the MS-Windows API.  It has been developed to facilitate implementation
  15 of the GUI components of mingw-get; as such, it does not aim to provide
  16 a fully featured API class framework, but rather, it is restricted to
  17 providing only those features which are necessary for mingw-get.
  18
  19 It may be extended in the future, as the need arises.
  20
  21
  22 Licence
  23 -------
  24
  25 Permission is hereby granted, free of charge, to any person obtaining a
  26 copy of this software and associated documentation files (the "Software"),
  27 to deal in the Software without restriction, including without limitation
  28 the rights to use, copy, modify, merge, publish, distribute, sublicense,
  29 and/or sell copies of the Software, and to permit persons to whom the
  30 Software is furnished to do so, subject to the following conditions:
  31
  32 The above copyright notice and this permission notice shall be included
  33 in all copies or substantial portions of the Software.
  34
  35 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  36 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  37 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  38 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  39 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  40 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  41 DEALINGS IN THE SOFTWARE.
  42
  43
  44 Building from a Source TarBall
  45 ------------------------------
  46
  47 This package is delivered in source format, suitable for building in
  48 accordance with the standard GNU paradigm; building out-of-source, (or
  49 in a subdirectory of the source tree), is recommended:--
  50
  51   1) tar xf wtk-<version>-mingw32-src.tar.gz
  52   2) mkdir wtk-<version>/build
  53   3) cd wtk-<version>/build
  54   4) ../configure
  55   5) make
  56   6) make install
  57
  58
  59 Building from SCM Repository
  60 ----------------------------
  61
  62 If the source code has been obtained from MinGW.org's git repository, it
  63 will be necessary to also source the build-aux module from this repository,
  64 and link, (or copy), the install-sh file into the top source directory of
  65 the WTK tree.  Then, cd to the top of the WTK tree, and proceed:--
  66
  67   1) autoconf
  68   2) mkdir build
  69   3) cd build
  70   4) ../configure
  71   5) make
  72   6) make install
  73
  74 $RCSfile$: end of file