ratox

commit f07071973f3d26db1ad0e850598a56da799753fa
parent c0d6bab9d075146fdb0d60df77a3dddd0f4c33c1
Author: sin <sin@2f30.org>
Date:   Wed,  8 Oct 2014 14:49:50 +0100

Update README

Diffstat:
M
README
 | 
47
+++++++++++++++++++++++++++--------------------

1 file changed, 27 insertions(+), 20 deletions(-)
diff --git a/README b/README
@@ -24,41 +24,48 @@ to help explain the semantics of the individual files.
 
 .
 |-- .ratox.data			# ratox save file
+|
 |-- 0A734CBA717CEB7883D....	# friend's ID excluding nospam + checksum
-|   |-- call_in			# arecord -r 48000 -c 1 -f S16_LE > call_in to initiate a call
-|   |-- call_out		# aplay -r 48000 -c 1 -f S16_LE - < call_out to answer a call
+|   |-- call_in			# 'arecord -r 48000 -c 1 -f S16_LE > call_in' to initiate a call
+|   |-- call_out		# 'aplay -r 48000 -c 1 -f S16_LE - < call_out' to answer a call
 |   |-- call_pending		# 1 if a call is pending, 0 otherwise
-|   |-- file_in			# cat foo > file_in to send a file
-|   |-- file_out		# cat file_out > bar to receive a file
+|   |-- file_in			# 'cat foo > file_in' to send a file
+|   |-- file_out		# 'cat file_out > bar' to receive a file
 |   |-- file_pending		# contains filename if transfer pending, empty otherwise
 |   |-- name			# friend's nickname
 |   |-- online			# 1 if friend online, 0 otherwise
-|   |-- remove			# echo 1 > remove
-|   |-- state			# {none,away,busy}
+|   |-- remove			# 'echo 1 > remove' to remove a friend
+|   |-- state			# friend's user state; could be any of {none,away,busy}
 |   |-- status			# friend's status message
-|   |-- text_in			# echo yo dude > text_in
-|   `-- text_out		# tail -f text_out
-|-- id				# our own ID
+|   |-- text_in			# 'echo yo dude > text_in' to send a text to this friend
+|   `-- text_out		# 'tail -f text_out' to dump to stdout any text received
+|
+|-- id				# 'cat id' to show your own ID, you can give this to your friends
+|
 |-- name			# changing your nick
 |   |-- err			# nickname related errors
-|   |-- in			# echo my-new-nick > in
-|   `-- out			# cat out to show your name
+|   |-- in			# 'echo my-new-nick > in' to change your name
+|   `-- out			# 'cat out' to show your name
+|
 |-- nospam			# changing your nospam
 |   |-- err			# nospam related errors
-|   |-- in			# echo AABBCCDD > in
-|   `-- out			# cat out to show your nospam
-|-- request			# initiate/accept friend requests
+|   |-- in			# 'echo AABBCCDD > in' to change your nospam
+|   `-- out			# 'cat out' to show your nospam
+|
+|-- request			# send and accept friend requests
 |   |-- err			# request related errors
-|   |-- in			# echo LONGASSID yo dude add me > in
-|   `-- out			# echo 1 > out/LONGASSID to accept a request
+|   |-- in			# 'echo LONGASSID yo dude add me > in' to send a friend request
+|   `-- out			# 'echo 1 > out/LONGASSID' to accept the friend request
+|
 |-- state			# changing your user state
 |   |-- err			# user status related errors
-|   |-- in			# echo away > in could be any of {none,away,busy}
-|   `-- out			# cat out to show your user state
+|   |-- in			# 'echo away > in' to change your user state; could be any of {none,away,busy}
+|   `-- out			# 'cat out' to show your user state
+|
 `-- status			# changing your status message
     |-- err			# status message related errors
-    |-- in			# cat I am bored to death > in
-    `-- out			# cat out to show your status message
+    |-- in			# 'cat I am bored to death > in' to change your status message
+    `-- out			# 'cat out' to show your status message
 
 Features
 ========