repositories
/
deb_shairplay.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
61c2f5d
)
Some clarifications in the README.md
author
Juho Vähä-Herttua
<juhovh@iki.fi>
Tue, 9 Apr 2013 08:54:39 +0000
(11:54 +0300)
committer
Juho Vähä-Herttua
<juhovh@iki.fi>
Tue, 9 Apr 2013 08:54:39 +0000
(11:54 +0300)
README.md
patch
|
blob
|
blame
|
history
diff --git
a/README.md
b/README.md
index e578bbef0a2f17f58b067c6d322c9941bbed220d..5a0d70c69930aa8a60643f3ee5d313c8f75308c8 100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-1,6
+1,8
@@
Shairplay
=========
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
----------
Disclaimer
----------
@@
-20,6
+22,7
@@
Description
Short description about what each file in the main library does:
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)
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
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:
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
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
+```