X-Git-Url: https://git.sesse.net/?p=cubemap;a=blobdiff_plain;f=README;h=056f705b80cc4d9f481c18e273c4284af3dc46ec;hp=c3175167d742928b2c454662b6cbb5f4faa11bfb;hb=6544fa0ec3f3a501bcb89ea977756911bd7f3ebd;hpb=209631aff205c124059b9e4ae7e93c3fb7a4194f

diff --git a/README b/README
index c317516..056f705 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 Cubemap is a high-performance, high-availability video reflector,
-specifically made for use with VLC. It is currently in alpha stage.
+specifically made for use with VLC.
 
 A short list of features:
 
@@ -12,20 +12,24 @@ A short list of features:
    and sending a SIGHUP; all clients will continue as if nothing had happened
    (unless you delete the stream they are watching, of course).
    Cubemap also survives the encoder dying and reconnecting.
- - Per-stream fwmark support, for TCP pacing through tc (separate config needed).
+ - Support for setting max pacing rate through the fq packet scheduler
+   (depends on Linux 3.13 or newer).
  - Reflects anything VLC can reflect over HTTP, even the muxes VLC
    has problems reflecting itself (in particular, FLV).
+ - Multicast support, both for sending and receiving (supports only protocols
+   that can go over UDP, e.g. MPEG-TS). Supports both ASM and SSM.
  - IPv4 support. Yes, Cubemap even supports (some) legacy protocols.
 
 
 HOWTO:
 
-  sudo aptitude install libprotobuf-dev protobuf-compiler
+  sudo aptitude install libprotobuf-dev protobuf-compiler libsystemd-dev
+  ./configure
   make -j4
 
-If you want to use HTTP input (you probably want to), patch VLC with the
-included file vlc-metacube.diff. Then start the VLC encoder with the
-“metacube” flag to the http access mux, like this:
+If you want to use HTTP input (you probably want to), you want VLC 2.2.0
+or newer. Then start the VLC encoder with the “metacube” flag to the http
+access mux, like this:
 
   cvlc [...] --sout '#std{access=http{metacube,mime=video/x-flv},mux=flv,dst=:4013/test.flv}'
 
@@ -44,9 +48,10 @@ keeps going.
 
 Munin plugins:
 
-These can be dropped directly into /etc/munin/plugins. If you don't put
-the files in the expected default locations, you probably want some
-configuration in /etc/munin/plugin-conf.d/cubemap or similar, like this:
+To activate these, symlink them into /etc/munin/plugins. If you don't put
+the files in the expected default locations (as done by 'make install'),
+you probably want some configuration in /etc/munin/plugin-conf.d/cubemap or
+similar, like this:
 
 [cubemap*]
 user <something>
@@ -57,5 +62,5 @@ env.cubemap_input_stats /var/lib/cubemap/cubemap-input.stats
 
 Legalese: 
 
-Copyright 2013 Steinar H. Gunderson <sgunderson@bigfoot.com>.
+Copyright 2013 Steinar H. Gunderson <steinar+cubemap@gunderson.no>.
 Licensed under the GNU GPL, version 2. See the included COPYING file.