summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README40
1 files changed, 40 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1ce0ebd
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+cybd - The cyber radio daemon
+=============================
+cybd is a lightweight, embeddable POSIX-compliant queued HSL muxer.
+
+HSL (http live stream) is a popular streaming protocol capable of transporting
+audio-video content over HTTP. cybd can play the role of the HSL server to
+generate an .m3u8 tracklist file and .ts segments files which can be served by
+any standard web server.
+
+Requirements
+------------
+In order to build cybd you need the ffmpeg API header files.
+
+
+Installation
+------------
+Edit config.mk to match your local setup (cybd is installed into the /usr/local
+namespace by default).
+
+Afterwards enter the following command to build and install cybd (if necessary as
+root):
+
+ make clean install
+
+
+Running cybd
+------------
+A cybd deamon must first be launched by invoking the 'daemon' command:
+
+ cybd [-s socket] daemon
+
+Then:
+
+ cybd [-s socket] COMMAND <args>
+
+
+Hacking cybd
+------------
+cybd was built with versatility in mind, and can be embedded in your server stack
+in several different ways. Read HACKING for more on that.