From: Juho Vähä-Herttua Date: Tue, 9 Apr 2013 08:54:39 +0000 (+0300) Subject: Some clarifications in the README.md X-Git-Tag: upstream/0.9.0~4^2~33 X-Git-Url: https://git.piment-noir.org/?p=deb_shairplay.git;a=commitdiff_plain;h=fb0fa0be72145b912cfeda38a94a2ccf7897394c Some clarifications in the README.md --- diff --git a/README.md b/README.md index e578bbe..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 ---------- @@ -20,6 +22,7 @@ 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) @@ -35,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 +```