summaryrefslogtreecommitdiff
path: root/tcl/win/README
diff options
context:
space:
mode:
Diffstat (limited to 'tcl/win/README')
-rw-r--r--tcl/win/README119
1 files changed, 100 insertions, 19 deletions
diff --git a/tcl/win/README b/tcl/win/README
index 15cea28f10f..d1c67d538ab 100644
--- a/tcl/win/README
+++ b/tcl/win/README
@@ -1,23 +1,104 @@
-Tk 8.4 for Windows
-
-Originally by Scott Stanton while at Sun Microsystems Labs
+Tcl 8.4 for Windows
RCS: @(#) $Id$
+1. Introduction
+---------------
+
This is the directory where you configure and compile the Windows
-version of Tk. This directory also contains source files for Tk
-that are specific to Microsoft Windows. The rest of this file
-contains information specific to the Windows version of Tk.
-
-Please see the README and win/README files that come with the
-associated Tcl release for an extensive set of pointers to
-documentation. You will need to obtain and compile the
-Tcl release before using the Tk source distrition.
-
-If you install the Tk sources next to the Tcl sources, then
-the Tk Makefiles (e.g., makefile.vc for VC++) will properly
-locate the necessary Tcl files. Otherwise you may need to
-edit makefile.vc and adjust the path to Tcl accordingly.
-
-Information about compiling for windows is maintained at:
- http://www.tcl.tk/doc/howto/compile.html
+version of Tcl. This directory also contains source files for Tcl
+that are specific to Microsoft Windows.
+
+The information in this file is maintained on the web at:
+ http://www.tcl.tk/doc/howto/compile.html#win
+
+The above URL includes a lengthy discussion of compiler macros necessary
+when compiling Tcl extensions that will be dynamically loaded.
+
+2. Compiling Tcl
+----------------
+
+In order to compile Tcl for Windows, you need the following:
+
+ Tcl 8.4 Source Distribution (plus any patches)
+
+ and
+
+ Visual C++ 5 or newer
+
+ or
+
+ Msys + Mingw 1.1
+
+ http://prdownloads.sourceforge.net/tcl/msys_mingw2.zip
+
+ This Msys + Mingw download is the minimal environment
+ needed to build Tcl/Tk under Windows. It includes a
+ shell environment and gcc. The release is designed to
+ make it as easy a possible to build Tcl/Tk. To install,
+ you just download the zip file and extract the files
+ into a directory. The README.TXT file describes how
+ to launch the msys shell, you then run the configure
+ script in the tcl/win directory.
+
+ or
+
+ Cygwin 1.1 or newer (See http://sources.redhat.com/cygwin)
+
+ Mingw 1.1 (http://prdownloads.sourceforge.net/mingw/MinGW-1.1.tar.gz)
+
+ Extract the contents of the archive file into /usr/local/mingw
+ and place /usr/local/mingw/bin at the front of your PATH env var
+ before running the configure script in the tcl/win directory.
+
+
+In practice, this release is built with Visual C++ 6.0 and the TEA
+Makefile.
+
+If you are building with Visual C++, in the "win" subdirectory of the
+source release, you will find "makefile.vc". This is the makefile for
+the Visual C++ compiler and uses the stock NMAKE tool. Detailed
+directions for using it, are in the comments of "makefile.vc". A quick
+example would be:
+ C:\tcl_source\win\>nmake -f makefile.vc
+
+There is also a Developer Studio workspace and project file, too, if you
+would like to use them.
+
+If you are building with Msys or Cygwin, you can use the configure script
+that lives in the win subdirectory. The Msys or Cygwin based configure/build
+process works just like the UNIX one, so you will want to refer to
+../unix/README for available configure options. An error will be
+generated by the configure script if you try to compile Tcl with
+the Cygwin version of gcc instead of the Mingw version. Check your
+PATH if you get this error. Be aware that gcc will generate
+lots of compile time warnings when building Tcl. Warnings are
+not errors, so please don't file a bug report about them.
+
+In order to use the binaries generated by these makefiles, you will
+need to place the Tcl script library files someplace where Tcl can
+find them. Tcl looks in one of following places for the library files:
+
+ 1) The path specified in the environment variable "TCL_LIBRARY".
+
+ 2) Relative to the directory containing the current .exe.
+ Tcl will look for a directory "..\lib\tcl8.4" relative to the
+ directory containing the currently running .exe.
+
+Note that in order to run tclsh84.exe, you must ensure that tcl84.dll
+and tclpip84.dll are on your path, in the system directory, or in the
+directory containing tclsh84.exe.
+
+Note: Tcl no longer provides support for Win32s.
+
+3. Test suite
+-------------
+
+This distribution contains an extensive test suite for Tcl. Some of
+the tests are timing dependent and will fail from time to time. If a
+test is failing consistently, please send us a bug report with as much
+detail as you can manage. Please use the online database at
+ http://tcl.sourceforge.net/
+
+In order to run the test suite, you build the "test" target using the
+appropriate makefile for your compiler.