From: Juho Vähä-Herttua Date: Tue, 13 Mar 2012 13:53:09 +0000 (+0200) Subject: Update the README to contain more information about files. X-Git-Tag: upstream/0.9.0~4^2~118 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=ce17dc8df12ab3bc320f4651552632d7feea389e;p=deb_shairplay.git Update the README to contain more information about files. --- diff --git a/README b/README index 0b23c59..700c032 100644 --- a/README +++ b/README @@ -9,3 +9,33 @@ src/* - LGPLv2.1 License AirTV-Qt/* - LGPLv2.1 License I haven't had time to clarify the licenses used in the source code yet, that is on TODO list. + +Description +----------- + +Short description about what each file in the main library does: + +src/base64.* - base64 encoder/decoder +src/dnssd.* - dnssd helper functions +src/http_parser.* - HTTP parser from joyent (nginx fork) +src/http_request.* - Request parser that uses http_parser +src/http_response.* - Extremely simple HTTP response serializer +src/httpd.* - Generic HTTP/RTSP server +src/logger.* - Logging related functions +src/netutils.* - Mostly socket related code +src/raop.* - Main RAOP handler, handles all RTSP stuff +src/raop_rtp.* - Handles the RAOP RTP related stuff (UDP/TCP) +src/raop_buffer.* - Parses and buffers RAOP packets, resend logic here +src/rsakey.* - Decrypts and parses the RSA key to bigints +src/rsapem.* - Converts the RSA PEM key to DER encoded bytes +src/sdp.* - Extremely simple RAOP specific SDP parser +src/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 +