commit 91b42cfb9e3953dad076de3aaf0ec1b37b9f4c7d
parent 2f04542cf6e90ab8f52d0a0dc8a4ec662b54511a
Author: Luxferre <lux@ferre>
Date: Fri, 1 Nov 2024 07:51:45 +0200
updated readme to reflect recent changes
Diffstat:
1 file changed, 5 insertions(+), 7 deletions(-)
diff --git a/README b/README
@@ -2,14 +2,12 @@ tii: a Tcl-based suite for working with ii/IDEC protocol
========================================================
This suite implements the client side of ii and (partially) IDEC protocols of
distributed, cross-platform, text-based communication (a FIDOnet successor, so
-to speak). Protocol documentation can be found here for both ii and IDEC:
-https://github.com/IDEC-net/new-docs/blob/master/protocol-en.md
-(this is an official link, see ii-doc.txt for more concise documentation)
+to speak). See ii-doc.txt for the protocol documentation.
The tii suite requires at least Tcl 8.6 to run. Running it inside starpacks is
possible but not recommended.
-The tii repo consists of the following parts:
+The tii distribution consists of the following parts:
* tiifetch.tcl: the core ii/IDEC message fetching library and CLI utility
* tiipost.tcl: the core ii/IDEC message posting library and CLI utility
@@ -17,9 +15,9 @@ The tii repo consists of the following parts:
* tii.db: the SQLite3 database that contains all messages and echo lists
* config.txt: the set of parameters for all HTTP requests by the tii scripts
* stations.txt: the list of stations to be auto-fetched by tiifetch when none
- of its command-line parameters is passed
+ of its command-line parameters is passed (not included in the repo)
* auth.txt: the list of station/authstring mappings to be used by tiipost when
- posting messages to a particular station
+ posting messages to a particular station (not included in the repo)
* tiix.tcl: the GUI ii/IDEC viewer that also leverages tiifetch and tiipost to
provide fetching and posting functionality
@@ -150,6 +148,7 @@ the file is a Tcl dictionary (`key "value"`) and has the following fields:
will connect directly)
* proxyport: the HTTP port to use on the proxy (only effective if proxyhost is
set to a non-empty string)
+* net_timeout: the timeout (in milliseconds) for all network requests
Any of the fields can be omitted, as well as the file itself.
You can also use torsocks with any script invocation in order to fully cloak
@@ -158,7 +157,6 @@ your originating IP address.
FAQ
---
-
- Does tii implement any IDEC extensions?
Only one: fetching list.txt from the station to get the entire list of echo
