Updated manual.
[shell-fm.git] / README.textile
blob48b3c20ad569ebf15ec589d49a61b2f42862465e
1 h2. About
3 shell-fm is a lightweight, console-based player for Last.FM radio streams. It's pretty small (the binary is currently a little smaller than 60K, or 50K when stripped) and it has most features the "official" player has, if not even a few more. Additional features are, for example:
5 * network interface (control shell-fm remotely)
6 * autoban (automatically ban all tracks of an artist you don't like)
7 * bookmark stations (quickly jump to bookmarked stations with a single key)
8 * ... probably more
10 h2. Requirements
12 shell-fm doesn't need much. You definitely need libmad. shell-fm can also use libao for playback (optional).
14 h2. Installation
16 It's always recommended to use the latest version from GitHub.
18 First clone the repository:
20 bc. $ git clone git://github.com/jkramer/shell-fm.git
22 Make sure you have the needed libraries to compile (libmad0-dev and libao-dev.) This should do the trick for Ubuntu:
24 bc. $ sudo apt-get install libmad0-dev libao-dev
26 Change into the repository directory and compile Shell.FM:
28 bc. $ cd shell-fm
29 $ make
31 Finally, install the binary and the manual as root:
33 bc. $ su -c "make install"
34 OR:
35 $ sudo make install