summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJaromil <jaromil@dyne.org>2008-11-07 16:02:45 (GMT)
committer Jaromil <jaromil@dyne.org>2008-11-07 16:02:45 (GMT)
commit236dfa92f1ce18974706806b3dc8f8e71b122348 (patch)
tree5e082951017c0ad967d9f6759190ab92e910fe5c
parent7e3d885d17737a15bed76bb59201d4d5092b24d3 (diff)
some more documentation updates
-rw-r--r--README.mutt34
-rw-r--r--slw/README8
-rw-r--r--tbt.153
3 files changed, 41 insertions, 54 deletions
diff --git a/README.mutt b/README.mutt
deleted file mode 100644
index 6a496b2..0000000
--- a/README.mutt
+++ /dev/null
@@ -1,34 +0,0 @@
-
-The first integration provided for TBT is with Mutt
-http://www.mutt.org the Mail User Agent popular among
-text console users.
-
-= How to set up integration of TBT in Mutt
-
-Include the following settings in your muttrc config:
-
-set editor = recmail
-set edit_headers = yes
-
-then include the following line in your mime.types
-(by default in user's directory as ~/.mime.types)
-
-application/x-tbt tbt
-
-and finally include this line in your mailcap
-(by default in user's directory as ~/.mailcap)
-
-application/x-tbt; playtext %s; needsterminal
-
-
-Now if you have the programs recmail and playtext
-in your path you can record and play TBT mails.
-
-It is most comfortable to keep your favourite editor by default in
-mutt, and use TBT only when needed with the commandline command:
-
-mutt -e 'set editor = recmail; set edit_headers = yes'
-
-to compose your time based messages.
-
-
diff --git a/slw/README b/slw/README
index 6e87d26..2f490d9 100644
--- a/slw/README
+++ b/slw/README
@@ -1,11 +1,16 @@
-S-Lang widgets by Jaromil
+S-Lang widgets by Jaromil http://jaromil.dyne.org
This simple set of widgets are developed on top of the console library
S-Lang, providing a thread safe implementation in C++ for console
interface elements as popup boxes, scroll text boxes and more in
future: this is just a start and will hopefully grow in needs.
+Main features that this library aims to achieve:
+ - Low latency in operations (must react fast!)
+ - Modularity and ease of use design
+ - Complete thread safety
+
Most notable there is the abs_text_console which is an abstract
implementation for a text scrolling console (a la readline, but
different) that is also ported to javascript for TBT. Abstract means
@@ -13,4 +18,3 @@ this text console handling is completely independent from other
libraries and can be included in other software components (as for
instance FreeJ for playback of TBT files in videos).
-
diff --git a/tbt.1 b/tbt.1
index 764adac..4ffb3a4 100644
--- a/tbt.1
+++ b/tbt.1
@@ -1,25 +1,32 @@
-.TH tbt 1 "April 13, 2007" "tbt"
+.TH tbt 1 "November 7, 2008" "tbt"
.SH NAME
-tbt \- Time Based Text
+TBT \- Time Based Text
.SH SYNOPSIS
.B tbt [options] [file]
.SH DESCRIPTION
-.B tbt - Time Based Text
-To vehicle more human-input information in written text.
+This software is written to vehicle more human-input information in
+written text.
-Record performance time of written text and vehicle it as additional information: saving and reproducing every single action during the composition of a text let us vehicle emphasis in written communication.
+We record performance time of written text and vehicle it as
+additional information: saving and reproducing every single action
+during the composition of a text let us vehicle emphasis in written
+communication.
-As this simple concept, our implementation is also kept very minimalistic while we welcome programmers to embed it in communication applications, as in emails, blogs, visual poetry, slides and what not.
+As this simple concept, our implementation is also kept very
+minimalistic while we welcome programmers to embed it in communication
+applications, as in emails, blogs, visual poetry, slides and what not.
-Beware this software is hacky, u need to love text. A manual page is provided and commandline formulas to be casted in a terminal.
+Beware this software is minimalistic, you need to love text.
-This software is written in thread-safe POSIX C++ and can be ported to most platforms, it provides a real-time recorder for serial timed data, recording 64bit tuples key/msec with low-latency. Included are programs providing a text console interface for the user to experiment with keyboard.
-
-A Web application written in PHP/MySQL and Ajax could be used to publish TBT written into the world wide web.
+This manual will follow documenting the TBT protocol and usage, with
+commandline formulas to be casted in a terminal. Included in the
+sourcecode is also a website written in PHP/MySQL/Ajax to publish TBT
+written into the world wide web, as well a Python-GTK graphical user
+interface.
.SH PROTOCOL
@@ -33,9 +40,19 @@ In the .tbt format, text is saved with a timestamp for each letter:
| Total: 128bit |
---------------------
-However export to different formats is planned including generation of web-ready code in HTML and Javascript, a daemon to provide timed input thru a socket on the network (TCP/IP) and what not.
+This software is written in thread-safe POSIX C++ and can be ported to
+most platforms, it provides a real-time recorder for serial timed
+data, recording 64bit tuples key/msec with low-latency. Included are
+programs providing a text console interface for the user to experiment
+with keyboard.
+
+Input is captured from the console, but can be extended to intercept
+any application using some h4x0r keylogging technique on different OS.
+
+Export functionality to different formats is provided, including
+generation of web-ready code in HTML and Javascript.
+
-Input is captured from the console, but can be extended to intercept any application using some h4x0r keylogging technique on different OS.
.SH COMMANDS
@@ -120,13 +137,13 @@ $ tbt -c -r -s ascii mytext.txt
$ tbt -c -r -s html mytext.html
-.SH NOTES
-The first integration provided for TBT is with Mutt \fIhttp://www.mutt.org\fR the Mail User Agent popular among text console users.
-For further information please read the README.mutt file.
-
.SH BUGS
Everyone is encouraged to test this software and report bugs!
-Send remarks and patches to http://dyne.org/hackers_contact.php or get in touch with coders via irc.freenode.net channel #dyne
+
+Please use the web page http://bugs.dyne.org
+
+Get in touch with developers via mail using this web page
+http://dyne.org/hackers_contact.php or via chat on http://irc.dyne.org
.SH AUTHORS
Time Based Text software by Denis Roio - http://jaromil.dyne.org
@@ -147,7 +164,7 @@ Thanks to: Florian Cramer, Annet Dekker, Paul Hendriks
.SH COPYING
-This manual is Copyleft (c) 2007-2008 Denis Rojo <\fIjaromil@dyne.org\fR>
+This manual is Copyleft (c) 2007-2008 Denis Roio <\fIjaromil@dyne.org\fR>
Permission is granted to copy, distribute and/or modify this manual
under the terms of the GNU Free Documentation License, Version 1.1 or