Imported Debian patch 1.2.3-1~0
[ympd-debian.git] / README.md
1 ympd
2 ====
3
4 Standalone MPD Web GUI written in C, utilizing Websockets and Bootstrap/JS
5
6
7 http://www.ympd.org
8
9 ![ScreenShot](http://www.ympd.org/assets/ympd_github.png)
10
11 Dependencies
12 ------------
13  - libmpdclient 2: http://www.musicpd.org/libs/libmpdclient/
14  - cmake 2.6: http://cmake.org/
15
16 Unix Build Instructions
17 -----------------------
18
19 1. install dependencies, cmake and libmpdclient are available from all major distributions.
20 2. create build directory ```cd /path/to/src; mkdir build; cd build```
21 3. create makefile ```cmake ..  -DCMAKE_INSTALL_PREFIX:PATH=/usr```
22 4. build ```make```
23 5. install ```sudo make install``` or just run with ```./ympd```
24
25 Run flags
26 ---------
27 ```
28 Usage: ./ympd [OPTION]...
29
30  -h, --host <host>          connect to mpd at host [localhost]
31  -p, --port <port>          connect to mpd at port [6600]
32  -w, --webport [ip:]<port>  listen interface/port for webserver [8080]
33  -u, --user <username>      drop priviliges to user after socket bind
34  -V, --version              get version
35  --help                     this help
36 ```
37
38
39 Copyright
40 ---------
41
42 2013-2014 <andy@ndyk.de>