X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=70fcde97943611012e24fc563d89098b12ea754d;hb=258e9fb821c5ee9b39628d1694e48d5518e28ac3;hp=d8c7183cba42add11c7c854822bc30e0edfd3e28;hpb=1a1958cfba08314fc70e0b29309097f0509ee61e;p=deb_shairplay.git

diff --git a/README.md b/README.md
index d8c7183..70fcde9 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,47 @@
 Shairplay
 =========
-Free portable AirPlay server implementation.
+Free portable AirPlay server implementation similar to [ShairPort](https://github.com/abrasive/shairport).
+
+Currently only AirPort Express emulation is supported.
 
 Disclaimer
 ----------
 All the resources in this repository are written using only freely available
 information from the internet. The code and related resources are meant for
-educational purposes only. It is up to the user to make sure all local laws are
-adhered to.
+educational purposes only. It is the responsibility of the user to make sure
+all local laws are adhered to.
+
+Installation
+------------
+
+```
+./configure
+make
+sudo make install
+```
 
-Licenses
---------
+Notice that libao is required in order to install the shairplay binary,
+otherwise only the library is compiled and installed.
 
-Following licenses apply:
+Usage
+-----
 
-src/lib/alac/*         - MIT License
-src/lib/crypto/*       - New BSD License
-src/lib/http_parser.*  - MIT License
-src/lib/bindings/*     - MIT License
-src/lib/*              - LGPLv2.1+ License
-AirTV-Qt/*             - LGPLv2.1+ License
+Check available options with ```shairplay --help``` and start server with
+```shairplay```, if you are connected to a Wi-Fi the server should show as an
+AirPort Express on your iOS devices and Mac OS X computers in the same network.
 
-Also the following files are used, although not necessary:
+Related software
+----------------
 
-AirTV-Qt/qtsingleapplication/src/* - New BSD License
+* [ShairPort](https://github.com/abrasive/shairport), original AirPort Express emulator
+* [ALAC](http://craz.net/programs/itunes/alac.html), ALAC decoder by David Hammerton
 
 Description
 -----------
 
 Short description about what each file in the main library does:
 
+```
 src/lib/base64.*         - base64 encoder/decoder
 src/lib/dnssd.*          - dnssd helper functions
 src/lib/http_parser.*    - HTTP parser from joyent (nginx fork)
@@ -45,12 +57,15 @@ src/lib/rsakey.*         - Decrypts and parses the RSA key to bigints
 src/lib/rsapem.*         - Converts the RSA PEM key to DER encoded bytes
 src/lib/sdp.*            - Extremely simple RAOP specific SDP parser
 src/lib/utils.*          - Utils for reading a file and handling strings
+```
 
 Short description about what each file in the Qt application does:
 
+```
 AirTV-Qt/main.cpp                 - Initializes the application
 AirTV-Qt/mainapplication.cpp      - Creates the tray icon and starts RAOP
 AirTV-Qt/raopservice.cpp          - Handles all communication with the library
 AirTV-Qt/raopcallbackhandler.cpp  - Converts C callbacks to Qt callbacks
 AirTV-Qt/audiooutput.cpp          - Takes care of the actual audio output
+```