--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sat Mar 14 11:44:11 2015 +0100
@@ -0,0 +1,83 @@
+slrn Terminal Title Macro
+=========================
+
+The slrn terminal title macro displays user-defined information in the
+terminal title if supported by the terminal.
+
+Usage
+-----
+
+The slrn terminal title macro can be used by including it in the .slrnrc user
+initialization file via the `interpret` command, e.g. provided that the file
+terminal-title.sl is located in one of the directories specified by the
+macro_directory configuration variable:
+
+    interpret "terminal-title.sl"
+
+The terminal title macro can be configured through the following slang
+variables:
+
+TerminalTitle->article_title_format
+:   The string displayed in the terminal title in article mode.  The string
+    may contain certain substitution identifiers in order to insert
+    information from slrn at runtime.
+
+TerminalTitle->group_title_format
+:   The string displayed in the terminal title in group mode.  The string
+    may contain certain substitution identifiers in order to insert
+    information from slrn at runtime.
+
+Substitution identifiers always start with a "%" sign.  The following
+substitution identifiers can be referenced from
+TerminalTitle->article_title_format and TerminalTitle->group_title_format:
+
+v
+:   The slrn version.
+
+s
+:   The name of the current news server.
+
+n
+:   The name of the current newsgroup.
+
+Contact
+-------
+
+Please send any feedback, translations or bug reports via email to
+<guido+weechat@berhoerster.name>.
+
+Bug Reports
+-----------
+
+When sending bug reports, please always mention the exact version of the
+macro with which the issue occurs as well as the version of slrn, slang and
+the operating system you are using and make sure that you provide sufficient
+information to reproduce the issue and include any input, output, any error
+messages and slang stack traces.
+
+License
+-------
+
+Except otherwise noted, all files are Copyright (C) 2009 Guido Berhoerster and
+distributed under the following license terms:
+
+Copyright (C) 2009 Guido Berhoerster <guido+slrn@berhoerster.name>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.