add readme for github

This commit is contained in:
Andrew Karpow 2014-01-17 20:03:08 +01:00
parent 8c42ba2d7e
commit 2513d26eec
1 changed files with 28 additions and 0 deletions

28
README.md Normal file
View File

@ -0,0 +1,28 @@
ympd
====
Standalone MPD Web GUI written in C, utilizing Websockets and Bootstrap/JS
http://www.ympd.org
Dependencies
------------
- libwebsockets master branch: http://git.libwebsockets.org/cgi-bin/cgit/libwebsockets
- libmpdclient 2: http://www.musicpd.org/libs/libmpdclient/
- cmake 2.6: http://cmake.org/
- Optional: OpenSSL for SSL support in libwebsockets webserver
Unix Build Instructions
-----------------------
1. Install Dependencies, cmake, openssl and libmpdclient are available from all major distributions.
2. create build directory ```cd /path/to/src; mkdir build; cd build```
3. create makefile ```cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/usr```
4. build ```make```
5. install ```sudo make install``` or build debian package ```cpack -G DEB; sudo dpkg -i ympd*.deb```
Copyright
---------
2013-2014 <andy@ndyk.de>