Permalink
Browse files

Moved the documentation to README and added AUTHORS.

  • Loading branch information...
1 parent b912985 commit 3c94b72781ea03c05e50922fe4f4c7a9dc54150d Tilman Sauerbeck committed Feb 12, 2006
Showing with 36 additions and 12 deletions.
  1. +1 −0 AUTHORS
  2. +35 −0 README
  3. +0 −12 xmms2-scrobbler
View
@@ -0,0 +1 @@
+Tilman Sauerbeck (tilman at code-monkey de)
View
35 README
@@ -0,0 +1,35 @@
+XMMS2-Scrobbler
+===============
+
+About
+-----
+
+XMMS2-Scrobbler is a client for XMMS2 that feeds information about the songs
+you played to last.fm, formerly known as AudioScrobbler.
+
+
+Dependencies
+------------
+
+XMMS2-Scrobbler obviously depends on libxmmsclient (ships with XMMS2),
+Ruby, and the Ruby bindings for libxmmsclient (they ship with XMMS2 as well).
+In addition to this, you'll need the "event-loop" package for Ruby.
+Tarballs and gems are available at
+http://www.brockman.se/software/ruby-event-loop/.
+
+
+Usage
+-----
+
+First, you need to store your Audioscrobbler username and password
+in the config file:
+
+ echo -e "user: foo\npassword: bar" > \
+ ~/.xmms2/clients/xmms2-scrobbler/config
+
+Next, create a symlink to the script in ~/.xmms2/startup.d.
+This will make xmms2d start xmms2-scrobbler on startup. When xmms2d is
+killed, xmms2-scrobbler will exit automatically.
+
+In case anything doesn't work as it should, have a look at
+~/.xmms2/clients/xmms2-scrobbler/logfile.log.
View
@@ -1,16 +1,4 @@
#!/usr/bin/env ruby
-#
-# Usage:
-#
-# First, you need to store your Audioscrobbler username and password
-# in the config file:
-#
-# echo "user: foo\npassword: bar" > ~/.xmms2/clients/xmms2-scrobbler/config
-#
-# Next, create a symlink to the script in ~/.xmms2/startup.d.
-# This will make xmms2d start xmms2-scrobbler on startup. When xmms2d is
-# killed, xmms2-scrobbler will exit automatically.
-#
$VERBOSE = true

0 comments on commit 3c94b72

Please sign in to comment.