aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README54
1 files changed, 54 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..2530c96
--- /dev/null
+++ b/README
@@ -0,0 +1,54 @@
+README for ctct - a simple console contact manager
+
+Version 0.2.X
+
+
+How to install:
+---------------
+
+$ ./configure
+# make install
+
+You might want to change some variables when `./configure' is run.
+Most relevant candidates are 'prefix' and 'sysconfdir'.
+E.g.:
+$ ./configure prefix=/usr sysconfdir=/etc
+
+
+How to uninstall:
+-----------------
+
+# make uninstall
+
+Note that 'cmp' is required as an additional dependency.
+It is used to check whether the configuration files have changed and
+therefore can safely be removed.
+
+
+How to use:
+------------
+
+see the manpage - ctct(1)
+
+
+Dependencies:
+-------------
+
+bash
+grep
+coreutils
+
+
+Licensing:
+----------
+
+ctct is distributed under the GNU Affero General Public License (AGPL),
+version 3. See the file COPYING for further details.
+
+
+Author:
+-------
+
+ctct has been written by Einhard Leichtfuß alias respiranto.
+If you have any problems, questions, suggestions or similar concerning this
+program, you may write me an email to <ctct@respiranto.de>.