README.md
1# README: Tcl
2
3This is the **Tcl 8.7a5** source distribution.
4
5You can get any source release of Tcl from [our distribution
6site](https://sourceforge.net/projects/tcl/files/Tcl/).
7
8[](https://github.com/tcltk/tcl/actions?query=workflow%3A%22Linux%22+branch%3Acore-8-branch)
9[](https://github.com/tcltk/tcl/actions?query=workflow%3A%22Windows%22+branch%3Acore-8-branch)
10[](https://github.com/tcltk/tcl/actions?query=workflow%3A%22macOS%22+branch%3Acore-8-branch)
11
12## Contents
13 1. [Introduction](#intro)
14 2. [Documentation](#doc)
15 3. [Compiling and installing Tcl](#build)
16 4. [Development tools](#devtools)
17 5. [Tcl newsgroup](#complangtcl)
18 6. [The Tcler's Wiki](#wiki)
19 7. [Mailing lists](#email)
20 8. [Support and Training](#support)
21 9. [Tracking Development](#watch)
22 10. [Thank You](#thanks)
23
24## <a id="intro">1.</a> Introduction
25Tcl provides a powerful platform for creating integration applications that
26tie together diverse applications, protocols, devices, and frameworks.
27When paired with the Tk toolkit, Tcl provides the fastest and most powerful
28way to create GUI applications that run on PCs, Unix, and Mac OS X.
29Tcl can also be used for a variety of web-related tasks and for creating
30powerful command languages for applications.
31
32Tcl is maintained, enhanced, and distributed freely by the Tcl community.
33Source code development and tracking of bug reports and feature requests
34take place at [core.tcl-lang.org](https://core.tcl-lang.org/).
35Tcl/Tk release and mailing list services are [hosted by
36SourceForge](https://sourceforge.net/projects/tcl/)
37with the Tcl Developer Xchange hosted at
38[www.tcl-lang.org](https://www.tcl-lang.org).
39
40Tcl is a freely available open-source package. You can do virtually
41anything you like with it, such as modifying it, redistributing it,
42and selling it either in whole or in part. See the file
43`license.terms` for complete information.
44
45## <a id="doc">2.</a> Documentation
46Extensive documentation is available on our website.
47The home page for this release, including new features, is
48[here](https://www.tcl.tk/software/tcltk/8.7.html).
49Detailed release notes can be found at the
50[file distributions page](https://sourceforge.net/projects/tcl/files/Tcl/)
51by clicking on the relevant version.
52
53Information about Tcl itself can be found at the [Developer
54Xchange](https://www.tcl-lang.org/about/).
55There have been many Tcl books on the market. Many are mentioned in
56[the Wiki](https://wiki.tcl-lang.org/_/ref?N=25206).
57
58The complete set of reference manual entries for Tcl 8.7 is [online,
59here](https://www.tcl-lang.org/man/tcl8.7/).
60
61### <a id="doc.unix">2a.</a> Unix Documentation
62The `doc` subdirectory in this release contains a complete set of
63reference manual entries for Tcl. Files with extension "`.1`" are for
64programs (for example, `tclsh.1`); files with extension "`.3`" are for C
65library procedures; and files with extension "`.n`" describe Tcl
66commands. The file "`doc/Tcl.n`" gives a quick summary of the Tcl
67language syntax. To print any of the man pages on Unix, cd to the
68"doc" directory and invoke your favorite variant of troff using the
69normal -man macros, for example
70
71 groff -man -Tpdf Tcl.n >output.pdf
72
73to print Tcl.n to PDF. If Tcl has been installed correctly and your "man" program
74supports it, you should be able to access the Tcl manual entries using the
75normal "man" mechanisms, such as
76
77 man Tcl
78
79### <a id="doc.win">2b.</a> Windows Documentation
80The "doc" subdirectory in this release contains a complete set of Windows
81help files for Tcl. Once you install this Tcl release, a shortcut to the
82Windows help Tcl documentation will appear in the "Start" menu:
83
84 Start | Programs | Tcl | Tcl Help
85
86## <a id="build">3.</a> Compiling and installing Tcl
87There are brief notes in the `unix/README`, `win/README`, and `macosx/README`
88about compiling on these different platforms. There is additional information
89about building Tcl from sources
90[online](https://www.tcl-lang.org/doc/howto/compile.html).
91
92## <a id="devtools">4.</a> Development tools
93ActiveState produces a high-quality set of commercial quality development
94tools that is available to accelerate your Tcl application development.
95Tcl Dev Kit builds on the earlier TclPro toolset and provides a debugger,
96static code checker, single-file wrapping utility, bytecode compiler, and
97more. More information can be found at
98
99 http://www.ActiveState.com/Tcl
100
101## <a id="complangtcl">5.</a> Tcl newsgroup
102There is a USENET newsgroup, "`comp.lang.tcl`", intended for the exchange of
103information about Tcl, Tk, and related applications. The newsgroup is a
104great place to ask general information questions. For bug reports, please
105see the "Support and bug fixes" section below.
106
107## <a id="wiki">6.</a> Tcl'ers Wiki
108There is a [wiki-based open community site](https://wiki.tcl-lang.org/)
109covering all aspects of Tcl/Tk.
110
111It is dedicated to the Tcl programming language and its extensions. A
112wealth of useful information can be found there. It contains code
113snippets, references to papers, books, and FAQs, as well as pointers to
114development tools, extensions, and applications. You can also recommend
115additional URLs by editing the wiki yourself.
116
117## <a id="email">7.</a> Mailing lists
118Several mailing lists are hosted at SourceForge to discuss development or use
119issues (like Macintosh and Windows topics). For more information and to
120subscribe, visit [here](https://sourceforge.net/projects/tcl/) and go to the
121Mailing Lists page.
122
123## <a id="support">8.</a> Support and Training
124We are very interested in receiving bug reports, patches, and suggestions for
125improvements. We prefer that you send this information to us as tickets
126entered into [our issue tracker](https://core.tcl-lang.org/tcl/reportlist).
127
128We will log and follow-up on each bug, although we cannot promise a
129specific turn-around time. Enhancements may take longer and may not happen
130at all unless there is widespread support for them (we're trying to
131slow the rate at which Tcl/Tk turns into a kitchen sink). It's very
132difficult to make incompatible changes to Tcl/Tk at this point, due to
133the size of the installed base.
134
135The Tcl community is too large for us to provide much individual support for
136users. If you need help we suggest that you post questions to `comp.lang.tcl`
137or ask a question on [Stack
138Overflow](https://stackoverflow.com/questions/tagged/tcl). We read the
139newsgroup and will attempt to answer esoteric questions for which no one else
140is likely to know the answer. In addition, see the wiki for [links to other
141organizations](https://wiki.tcl-lang.org/training) that offer Tcl/Tk training.
142
143## <a id="watch">9.</a> Tracking Development
144Tcl is developed in public. You can keep an eye on how Tcl is changing at
145[core.tcl-lang.org](https://core.tcl-lang.org/).
146
147## <a id="thanks">10.</a> Thank You
148We'd like to express our thanks to the Tcl community for all the
149helpful suggestions, bug reports, and patches we have received.
150Tcl/Tk has improved vastly and will continue to do so with your help.
151
){kind=link}
){kind=link}
){kind=link}