summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README7
1 files changed, 7 insertions, 0 deletions
diff --git a/README b/README
index 9342bf1..633976c 100644
--- a/README
+++ b/README
@@ -8,6 +8,7 @@
-- by sin and FRIGN
======================================================
+
What is it?
===========
@@ -19,6 +20,7 @@ interaction through named pipes.
There's also a set of scripts[1] developed by various people that build on
top of the FIFO interface.
+
Getting started
===============
@@ -26,6 +28,7 @@ Get the latest version from the git-repository; build and install it.
Run ratox in an empty directory and it will create a set of files and
folders allowing you to control the client.
+
File structure
==============
@@ -77,6 +80,7 @@ to help explain the semantics of the individual files.
|-- in # 'cat I am bored to death > in' to change your status message
`-- out # 'cat out' to show your status message
+
Features
========
@@ -111,6 +115,7 @@ NOTE: Some of these features are not intended to be developed
in ratox itself but rather in external scripts that are built upon
ratox.
+
Examples
========
@@ -141,12 +146,14 @@ mplayer -cache 1024 file_out
You may have to play about with the cache size.
+
Portability
===========
Builds and works on *BSD and Linux. To build on OSX you need
to apply a patch[2].
+
Contact
=======