Update the README to contain more information about files.

diff --git a/README b/README
index 0b23c59055d6e9692248daa27e4c9e3b870b6ce2..700c03269aa00b86782f47eb4b307eedadd75abe 100644 (file)
--- 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
+