Skip to content

Commit 1fb0025

Browse files
committed
docs update
1 parent 43c97d0 commit 1fb0025

13 files changed

+62
-3043
lines changed

Diff for: README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@ The source of procedures is [Interpolation Routines](https://people.math.sc.edu/
1515

1616
For building you need:
1717
- [SWIG of version 4.3](https://www.swig.org/download.html)
18+
- [Tcl9](https://www.tcl.tk/software/tcltk/9.0.html)
1819
- [gcc compiler](https://gcc.gnu.org/)
20+
- [make tool](https://www.gnu.org/software/make/)
21+
- [autoconf tool](https://www.gnu.org/software/autoconf/)
1922

20-
For run you need:
21-
- [Tcl9](https://www.tcl.tk/software/tcltk/9.0.html)
23+
For run you also need:
2224
- [argparse](https://wiki.tcl-lang.org/page/argparse)
2325
- [Tcllib](https://www.tcl.tk/software/tcllib/)
2426

@@ -29,9 +31,16 @@ make
2931
sudo make install
3032
```
3133

34+
For Windows build it is strongly recommended to use [MSYS64 UCRT64 environment](https://www.msys2.org/), the above
35+
steps are identical if you run it from UCRT64 shell. After installing the package, you can move tclinterp package
36+
folder (usually located in `C:\msys64\ucrt64\lib\`) to path listed in `auto_path` variable of your local Tcl
37+
installation.
38+
3239
# Supported platforms
3340

34-
For now the only system I've tested it is Kubuntu 24.04 with Tcl9
41+
I've tested it on:
42+
- Kubuntu 24.04 with Tcl9
43+
- Windows 11 in MSYS64 UCRT64 environment with Tcl9
3544

3645
# Documentation
3746

Diff for: docs/index.html

+11-4
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,13 @@ <h1 class='ruff'><a name='Installation and dependencies'></a>Installation and de
2121
<p class='ruff'>For building you need:</p>
2222
<ul class='ruff'>
2323
<li><a href="https://www.swig.org/download.html" >SWIG of version 4.3</a></li>
24+
<li><a href="https://www.tcl.tk/software/tcltk/9.0.html" >Tcl9</a></li>
2425
<li><a href="https://gcc.gnu.org/" >gcc compiler</a></li>
26+
<li><a href="https://www.gnu.org/software/make/" >make tool</a></li>
27+
<li><a href="https://www.gnu.org/software/autoconf/" >autoconf tool</a></li>
2528
</ul>
26-
<p class='ruff'>For run you need:</p>
29+
<p class='ruff'>For run you also need:</p>
2730
<ul class='ruff'>
28-
<li><a href="https://www.tcl.tk/software/tcltk/9.0.html" >Tcl9</a></li>
2931
<li><a href="https://wiki.tcl-lang.org/page/argparse" >argparse</a></li>
3032
<li><a href="https://www.tcl.tk/software/tcllib/" >Tcllib</a></li>
3133
</ul>
@@ -36,9 +38,14 @@ <h1 class='ruff'><a name='Installation and dependencies'></a>Installation and de
3638
sudo make install
3739
</pre>
3840

39-
</figure><h1 class='ruff'><a name='Supported platforms'></a>Supported platforms<span class='ruff-uplink'><a href='#top'>Top</a>, <a href='index.html'>Main</a>, <a href='index-docindex.html#'>Index</a></span></h1>
41+
</figure><p class='ruff'>For Windows build it is strongly recommended to use <a href="https://www.msys2.org/" >MSYS64 UCRT64 environment</a>, the above steps are identical if you run it from UCRT64 shell. After installing the package, you can move tclinterp package folder (usually located in <code>C:\msys64\ucrt64\lib\</code>) to path listed in <code>auto_path</code> variable of your local Tcl installation.</p>
42+
<h1 class='ruff'><a name='Supported platforms'></a>Supported platforms<span class='ruff-uplink'><a href='#top'>Top</a>, <a href='index.html'>Main</a>, <a href='index-docindex.html#'>Index</a></span></h1>
4043
<div style='clear:both;'></div>
41-
<p class='ruff'>For now the only system I've tested it is Kubuntu 24.04 with Tcl9</p>
44+
<p class='ruff'>I've tested it on:</p>
45+
<ul class='ruff'>
46+
<li>Kubuntu 24.04 with Tcl9</li>
47+
<li>Windows 11 in MSYS64 UCRT64 environment with Tcl9</li>
48+
</ul>
4249
<h1 class='ruff'><a name='Documentation'></a>Documentation<span class='ruff-uplink'><a href='#top'>Top</a>, <a href='index.html'>Main</a>, <a href='index-docindex.html#'>Index</a></span></h1>
4350
<div style='clear:both;'></div>
4451
<p class='ruff'>You can find some documentation <a href="https://georgtree.github.io/tclinterp" >here</a></p>

Diff for: docs/index.n

+21-4
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,18 @@ For building you need:
1616
\fISWIG of version 4\&.3\fP [URL: https://www\&.swig\&.org/download\&.html]
1717
.TP
1818
\(bu
19+
\fITcl9\fP [URL: https://www\&.tcl\&.tk/software/tcltk/9\&.0\&.html]
20+
.TP
21+
\(bu
1922
\fIgcc compiler\fP [URL: https://gcc\&.gnu\&.org/]
20-
.PP
21-
For run you need:
2223
.TP
2324
\(bu
24-
\fITcl9\fP [URL: https://www\&.tcl\&.tk/software/tcltk/9\&.0\&.html]
25+
\fImake tool\fP [URL: https://www\&.gnu\&.org/software/make/]
26+
.TP
27+
\(bu
28+
\fIautoconf tool\fP [URL: https://www\&.gnu\&.org/software/autoconf/]
29+
.PP
30+
For run you also need:
2531
.TP
2632
\(bu
2733
\fIargparse\fP [URL: https://wiki\&.tcl-lang\&.org/page/argparse]
@@ -38,9 +44,20 @@ make
3844
sudo make install
3945
.fi
4046
.RE
47+
.PP
48+
For Windows build it is strongly recommended to use \fIMSYS64 UCRT64 environment\fP [URL: https://www\&.msys2\&.org/], the above
49+
steps are identical if you run it from UCRT64 shell\&. After installing the package, you can move tclinterp package
50+
folder (usually located in C:\\\\msys64\\\\ucrt64\\\\lib\\\\) to path listed in auto_path variable of your local Tcl
51+
installation\&.
4152
.SH "SUPPORTED PLATFORMS"
4253
.PP
43-
For now the only system I've tested it is Kubuntu 24\&.04 with Tcl9
54+
I've tested it on:
55+
.TP
56+
\(bu
57+
Kubuntu 24\&.04 with Tcl9
58+
.TP
59+
\(bu
60+
Windows 11 in MSYS64 UCRT64 environment with Tcl9
4461
.SH DOCUMENTATION
4562
.PP
4663
You can find some documentation \fIhere\fP [URL: https://georgtree\&.github\&.io/tclinterp]

Diff for: docs/startPage.ruff

+18-9
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,17 @@ variable startPage {
44

55
This package provides tcl wrapper for interpolation procedures.
66
The source of procedures is [Interpolation Routines](https://people.math.sc.edu/Burkardt/c_src/interp/interp.html).
7-
7+
88
# Installation and dependencies
9-
9+
1010
For building you need:
1111
- [SWIG of version 4.3](https://www.swig.org/download.html)
12+
- [Tcl9](https://www.tcl.tk/software/tcltk/9.0.html)
1213
- [gcc compiler](https://gcc.gnu.org/)
14+
- [make tool](https://www.gnu.org/software/make/)
15+
- [autoconf tool](https://www.gnu.org/software/autoconf/)
1316

14-
For run you need:
15-
- [Tcl9](https://www.tcl.tk/software/tcltk/9.0.html)
17+
For run you also need:
1618
- [argparse](https://wiki.tcl-lang.org/page/argparse)
1719
- [Tcllib](https://www.tcl.tk/software/tcllib/)
1820

@@ -22,13 +24,20 @@ variable startPage {
2224
make
2325
sudo make install
2426
```
25-
27+
28+
For Windows build it is strongly recommended to use [MSYS64 UCRT64 environment](https://www.msys2.org/), the above
29+
steps are identical if you run it from UCRT64 shell. After installing the package, you can move tclinterp package
30+
folder (usually located in `C:\msys64\ucrt64\lib\`) to path listed in `auto_path` variable of your local Tcl
31+
installation.
32+
2633
# Supported platforms
27-
28-
For now the only system I've tested it is Kubuntu 24.04 with Tcl9
29-
34+
35+
I've tested it on:
36+
- Kubuntu 24.04 with Tcl9
37+
- Windows 11 in MSYS64 UCRT64 environment with Tcl9
38+
3039
# Documentation
31-
40+
3241
You can find some documentation [here](https://georgtree.github.io/tclinterp)
3342

3443
}

Diff for: win/gitmanifest.in

-1
This file was deleted.

Diff for: win/makefile.vc

-59
This file was deleted.

0 commit comments

Comments
 (0)