Skip to content

Commit a9db71b

Browse files
Start overhaul of global docs (for the system, not packages).
1 parent 53a2510 commit a9db71b

8 files changed

+51
-123
lines changed

.github/CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11

2-
Hello.
2+
Hello. __Attention please__
33

44
You are currently using the github __mirror__ of the Tcllib sources.
55

6-
This is __not__ the location where development takes place.
6+
This is __not__ the location where Tcllib development takes place.
77

8-
We are not tracking issues entered here. With the exception of the
8+
We are __not tracking issues entered here__. With the exception of the
99
maintainer of the mirroring setup nobody will even see such issues.
1010

1111
Please go to the
12-
[official location of the sources](https://core.tcl.tk/tcllib)
12+
[official location of the sources](https://core.tcl-lang.org/tcllib)
1313
and enter your ticket into the
14-
[official ticket tracker](https://core.tcl.tk/tcllib/reportlist)
14+
[official ticket tracker](https://core.tcl-lang.org/tcllib/reportlist)
1515
instead.
1616

1717
Thank you for your consideration.

.github/ISSUE_TEMPLATE.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11

2-
Hello.
2+
Hello. __Attention please__
33

44
You are currently using the github __mirror__ of the Tcllib sources.
55

6-
This is __not__ the location where development takes place.
6+
This is __not__ the location where Tcllib development takes place.
77

8-
We are not tracking issues entered here. With the exception of the
8+
We are __not tracking issues entered here__. With the exception of the
99
maintainer of the mirroring setup nobody will even see such issues.
1010

1111
Please go to the
12-
[official location of the sources](https://core.tcl.tk/tcllib)
12+
[official location of the sources](https://core.tcl-lang.org/tcllib)
1313
and enter your ticket into the
14-
[official ticket tracker](https://core.tcl.tk/tcllib/reportlist)
14+
[official ticket tracker](https://core.tcl-lang.org/tcllib/reportlist)
1515
instead.
1616

1717
Thank you for your consideration.

.github/PULL_REQUEST_TEMPLATE.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11

2-
Hello.
2+
Hello. __Attention please__
33

44
You are currently using the github __mirror__ of the Tcllib sources.
55

6-
This is __not__ the location where development takes place.
6+
This is __not__ the location where Tcllib development takes place.
77

8-
We are not tracking issues entered here. With the exception of the
8+
We are __not tracking issues entered here__. With the exception of the
99
maintainer of the mirroring setup nobody will even see such issues.
1010

1111
Please go to the
12-
[official location of the sources](https://core.tcl.tk/tcllib)
12+
[official location of the sources](https://core.tcl-lang.org/tcllib)
1313
and enter your ticket into the
14-
[official ticket tracker](https://core.tcl.tk/tcllib/reportlist)
14+
[official ticket tracker](https://core.tcl-lang.org/tcllib/reportlist)
1515
instead.
1616

1717
Thank you for your consideration.

README

-96
This file was deleted.

README.md

+36-12
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,41 @@
1+
# Attention
12

2-
Hello.
3+
:warning:
4+
This repository is mirrored to [github](https://github.com/tcltk/tcllib).
35

4-
If you are reading this then you are very likely at the github
5-
__mirror__ of the Tcllib sources.
6-
7-
This means that the
8-
[official location of the sources](https://core.tcl.tk/tcllib)
9-
is somewhere else, just follow the link.
10-
11-
This is also where our issue tracking is done. We are not tracking
12-
issues at github. With the exeception of the maintainer of the
13-
mirroring setup nobody will even see issues created at github.
6+
We are __not tracking issues at github__. With the exeception of the
7+
maintainer of the mirroring setup nobody will even see issues created
8+
at github.
149

1510
Please use the
16-
[official ticket tracker](https://core.tcl.tk/tcllib/reportlist)
11+
[official ticket tracker](https://core.tcl-lang.org/tcllib/reportlist)
1712
instead.
13+
14+
# Welcome
15+
16+
Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a
17+
package itself. It is a collection of (semi-independent) Tcl packages
18+
that provide utility functions useful to a large collection of Tcl
19+
programmers.
20+
21+
At our [home site](http://core.tcl-lang.org/tcllib) you will find the
22+
official fossil repository used to manage our sources, together with
23+
the bug tracker. This is also the main location for releases to
24+
download from.
25+
26+
We have a
27+
[secondary download location](https://sourceforge.net/projects/tcllib/files)
28+
where the Tcllib sources were hosted in the past. SourceForge is also
29+
where our [mailing lists](https://sourceforge.net/p/tcllib/mailman)
30+
are (still) hosted.
31+
32+
Another location to find these sources at is the
33+
[github mirror](https://github.com/tcltk/tcllib).
34+
35+
Please note the :warning: at the top.
36+
37+
# More reading
38+
39+
Note that depending on your role with regard to Tcllib (developer,
40+
release manager, installer) we have additional README documents
41+
available with more information specific to that role.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)