summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2018-10-20 12:01:49 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2018-10-20 12:01:49 (GMT)
commitea29292705d5531747a472e71d3c59e9e9518f03 (patch)
tree87a0a44b2ce4d5620ea2540e90a4d0e0297f8f62 /README.md
parentd32d625787febc9c08fa7e1118df87ebfd4a9315 (diff)
downloadtcl-ea29292705d5531747a472e71d3c59e9e9518f03.zip
tcl-ea29292705d5531747a472e71d3c59e9e9518f03.tar.gz
tcl-ea29292705d5531747a472e71d3c59e9e9518f03.tar.bz2
formatting fix
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 15 insertions, 39 deletions
diff --git a/README.md b/README.md
index db67791..d5fe033 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-README: Tcl
-============
+# README: Tcl
+
This is the **Tcl 8.5.19** source distribution.
You can get any source release of Tcl from [our distribution
@@ -7,8 +7,7 @@ site](https://sourceforge.net/projects/tcl/files/Tcl/).
[![Build Status](https://travis-ci.org/tcltk/tcl.svg?branch=core-8-5-branch)](https://travis-ci.org/tcltk/tcl)
-Contents
---------
+## Contents
1. [Introduction](#intro)
2. [Documentation](#doc)
3. [Compiling and installing Tcl](#build)
@@ -20,8 +19,7 @@ Contents
9. [Tracking Development](#watch)
10. [Thank You](#thanks)
-1. <a id="intro">Introduction</a>
----------------
+## 1. <a id="intro">Introduction</a>
Tcl provides a powerful platform for creating integration applications that
tie together diverse applications, protocols, devices, and frameworks.
When paired with the Tk toolkit, Tcl provides the fastest and most powerful
@@ -42,9 +40,7 @@ anything you like with it, such as modifying it, redistributing it,
and selling it either in whole or in part. See the file
`license.terms` for complete information.
-2. <a id="doc">Documentation</a>
-----------------
-
+## 2. <a id="doc">Documentation</a>
Extensive documentation is available at our website.
The home page for this release, including new features, is
[here](https://www.tcl.tk/software/tcltk/8.5.html).
@@ -60,9 +56,7 @@ There have been many Tcl books on the market. Many are mentioned in
The complete set of reference manual entries for Tcl 8.5 is [online,
here](https://www.tcl-lang.org/man/tcl8.5/).
-2a. Unix Documentation
-----------------------
-
+### 2a. Unix Documentation
The `doc` subdirectory in this release contains a complete set of
reference manual entries for Tcl. Files with extension "`.1`" are for
programs (for example, `tclsh.1`); files with extension "`.3`" are for C
@@ -80,26 +74,20 @@ normal "man" mechanisms, such as
man Tcl
-2b. Windows Documentation
--------------------------
-
+### 2b. Windows Documentation
The "doc" subdirectory in this release contains a complete set of Windows
help files for Tcl. Once you install this Tcl release, a shortcut to the
Windows help Tcl documentation will appear in the "Start" menu:
Start | Programs | Tcl | Tcl Help
-3. <a id="build">Compiling and installing Tcl</a>
--------------------------------
-
+## 3. <a id="build">Compiling and installing Tcl</a>
There are brief notes in the `unix/README`, `win/README`, and `macosx/README`
about compiling on these different platforms. There is additional information
about building Tcl from sources
[online](https://www.tcl-lang.org/doc/howto/compile.html).
-4. <a id="devtools">Development tools</a>
----------------------------
-
+## 4. <a id="devtools">Development tools</a>
ActiveState produces a high quality set of commercial quality development
tools that is available to accelerate your Tcl application development.
Tcl Dev Kit builds on the earlier TclPro toolset and provides a debugger,
@@ -108,17 +96,13 @@ more. More information can be found at
http://www.ActiveState.com/Tcl
-5. <a id="complangtcl">Tcl newsgroup</a>
-----------------
-
+## 5. <a id="complangtcl">Tcl newsgroup</a>
There is a USENET news group, "`comp.lang.tcl`", intended for the exchange of
information about Tcl, Tk, and related applications. The newsgroup is a
great place to ask general information questions. For bug reports, please
see the "Support and bug fixes" section below.
-6. <a id="wiki">Tcl'ers Wiki</a>
----------------
-
+## 6. <a id="wiki">Tcl'ers Wiki</a>
There is a [wiki-based open community site](https://wiki.tcl-lang.org/)
covering all aspects of Tcl/Tk.
@@ -128,17 +112,13 @@ snippets, references to papers, books, and FAQs, as well as pointers to
development tools, extensions, and applications. You can also recommend
additional URLs by editing the wiki yourself.
-7. <a id="email">Mailing lists</a>
-----------------
-
+## 7. <a id="email">Mailing lists</a>
Several mailing lists are hosted at SourceForge to discuss development or use
issues (like Macintosh and Windows topics). For more information and to
subscribe, visit [here](https://sourceforge.net/projects/tcl/) and go to the
Mailing Lists page.
-8. <a id="support">Support and Training</a>
-------------------------
-
+## 8. <a id="support">Support and Training</a>
We are very interested in receiving bug reports, patches, and suggestions for
improvements. We prefer that you send this information to us as tickets
entered into [our issue tracker](https://core.tcl-lang.org/tcl/reportlist).
@@ -158,15 +138,11 @@ newsgroup and will attempt to answer esoteric questions for which no one else
is likely to know the answer. In addition, see the wiki for [links to other
organizations](https://wiki.tcl-lang.org/training) that offer Tcl/Tk training.
-9. <a id="watch">Tracking Development</a>
------------------------
-
+## 9. <a id="watch">Tracking Development</a>
Tcl is developed in public. You can keep an eye on how Tcl is changing at
[core.tcl-lang.org](https://core.tcl-lang.org/).
-10. <a id="thanks">Thank You</a>
--------------
-
+## 10. <a id="thanks">Thank You</a>
We'd like to express our thanks to the Tcl community for all the
helpful suggestions, bug reports, and patches we have received.
Tcl/Tk has improved vastly and will continue to do so with your help.