aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorAlexander Sulfrian <alexander@sulfrian.net>2010-10-15 13:51:12 +0200
committerAlexander Sulfrian <alexander@sulfrian.net>2010-10-15 13:51:12 +0200
commit2daaa9ada2754448a25686d66d9fc0ad25945265 (patch)
tree6c27fe3aa775f96aa7ecca8f36304677e485e927 /README
parente36f06647a317a4fe3fdf5c5bed6665714be2e99 (diff)
downloaderlang-2daaa9ada2754448a25686d66d9fc0ad25945265.tar.gz
erlang-2daaa9ada2754448a25686d66d9fc0ad25945265.tar.xz
erlang-2daaa9ada2754448a25686d66d9fc0ad25945265.zip
improved README
Diffstat (limited to '')
-rw-r--r--README51
1 files changed, 44 insertions, 7 deletions
diff --git a/README b/README
index 7ef9c8f..7e35fe5 100644
--- a/README
+++ b/README
@@ -1,7 +1,44 @@
-to compile: execute "make" in the top directory
-to start the server: run server/start.sh
-to start a client: cd client, erl -sname <any_name>
-in the client:
- client:register(<hostname>,<username>,<password>).
- client:login(<hostname>,<username>,<password>).
- now you can use client:list(), client:getVotes(), client:vote() and client:devote()
+Compilation
+===========
+
+execute "make" in the top directory
+
+
+Execution
+=========
+
+
+Server:
+
+execute "server/start.sh"
+If you want to have network support, you maybe have to supply your public IP adress as first parameter to that script.
+
+ T
+Client:
+
+cd client, erl -name <any_name>
+
+
+In the shell you can use the following commands:
+
+ client:register(<hostname>, <username>, <password>).
+ Register the first user account (admin).
+
+ client:login(<hostname>, <username>, <password>).
+ Login on the server.
+
+
+If you are logged in the server you can us the following commands:
+
+ client:list().
+ List all media objects.
+
+ client:getVotes().
+ Get your available votes.
+
+ client:vote(<artist>, <title>).
+ client:devote(<artist>, <title>).
+ Vote or devote the given media object.
+
+ client:register(<username>, <password>).
+ (only for admin accounts) Register a new user account.