Rename README to README.md and add a disclaimer
[deb_shairplay.git] / README.md
CommitLineData
1a1958cf
JVH
1Shairplay
2=========
3Free portable AirPlay server implementation.
4
5Disclaimer
6----------
7All the resources in this repository are written using only freely available
8information from the internet. The code and related resources are meant for
9educational purposes only. It is up to the user to make sure all local laws are
10adhered to.
11
8095e42a
JVH
12Licenses
13--------
14
15Following licenses apply:
16
57bb5c6c
JVH
17src/lib/alac/* - MIT License
18src/lib/crypto/* - New BSD License
19src/lib/http_parser.* - MIT License
6b27160f 20src/lib/bindings/* - MIT License
c85d0fa3
JVH
21src/lib/* - LGPLv2.1+ License
22AirTV-Qt/* - LGPLv2.1+ License
8095e42a 23
debab1b9
JVH
24Also the following files are used, although not necessary:
25
26AirTV-Qt/qtsingleapplication/src/* - New BSD License
ce17dc8d
JVH
27
28Description
29-----------
30
31Short description about what each file in the main library does:
32
57bb5c6c
JVH
33src/lib/base64.* - base64 encoder/decoder
34src/lib/dnssd.* - dnssd helper functions
35src/lib/http_parser.* - HTTP parser from joyent (nginx fork)
36src/lib/http_request.* - Request parser that uses http_parser
37src/lib/http_response.* - Extremely simple HTTP response serializer
38src/lib/httpd.* - Generic HTTP/RTSP server
39src/lib/logger.* - Logging related functions
40src/lib/netutils.* - Mostly socket related code
41src/lib/raop.* - Main RAOP handler, handles all RTSP stuff
42src/lib/raop_rtp.* - Handles the RAOP RTP related stuff (UDP/TCP)
43src/lib/raop_buffer.* - Parses and buffers RAOP packets, resend logic here
44src/lib/rsakey.* - Decrypts and parses the RSA key to bigints
45src/lib/rsapem.* - Converts the RSA PEM key to DER encoded bytes
46src/lib/sdp.* - Extremely simple RAOP specific SDP parser
47src/lib/utils.* - Utils for reading a file and handling strings
ce17dc8d
JVH
48
49Short description about what each file in the Qt application does:
50
51AirTV-Qt/main.cpp - Initializes the application
52AirTV-Qt/mainapplication.cpp - Creates the tray icon and starts RAOP
53AirTV-Qt/raopservice.cpp - Handles all communication with the library
54AirTV-Qt/raopcallbackhandler.cpp - Converts C callbacks to Qt callbacks
55AirTV-Qt/audiooutput.cpp - Takes care of the actual audio output
56