X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=5a0d70c69930aa8a60643f3ee5d313c8f75308c8;hb=fb0fa0be72145b912cfeda38a94a2ccf7897394c;hp=d8c7183cba42add11c7c854822bc30e0edfd3e28;hpb=1a1958cfba08314fc70e0b29309097f0509ee61e;p=deb_shairplay.git diff --git a/README.md b/README.md index d8c7183..5a0d70c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ 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 ---------- @@ -9,27 +11,18 @@ 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. -Licenses --------- - -Following licenses apply: - -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 - -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 +38,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 +```