X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=README;h=92ea7e1602b495160fac72a109162e69209e2bb0;hb=f98f6776f3a410c61dbf9fc523f28de7aa7fc154;hp=c941c04ce5e2d55f77a1f293613e37fb4547a57d;hpb=1548a68074134dbd4c0711a3c33a5f2204af61af;p=nageru

diff --git a/README b/README
index c941c04..92ea7e1 100644
--- a/README
+++ b/README
@@ -12,7 +12,7 @@ Features:
 
  - Proper sound support: Syncing of multiple unrelated sources through
    high-quality resampling, freely selectable input, cue out for headphones,
-   dynamic range compression, simple EQ (lowpass), level meters conforming
+   dynamic range compression, simple EQ (low-cut), level meters conforming
    to EBU R128.
 
  - Theme engine encapsulating the design demands of each individual
@@ -52,10 +52,10 @@ Nageru is in beta stage. It currently needs:
  - ffmpeg for muxing, and for encoding audio.
 
  - Working OpenGL; Movit works with almost any modern OpenGL implementation.
-   Nageru has been tested with Intel on Mesa 10.x and 11.x (you probably want
-   11.x), and with NVIDIA's proprietary drivers. AMD's proprietary drivers
-   (fglrx) are known not to work due to driver bugs; I am in contact with
-   AMD to try to get this resolved.
+   Nageru has been tested with Intel on Mesa (you want 11.2 or newer, due
+   to critical stability bugfixes), and with NVIDIA's proprietary drivers.
+   AMD's proprietary drivers (fglrx) are known not to work due to driver bugs;
+   I am in contact with AMD to try to get this resolved.
 
  - libzita-resampler, for resampling sound sources so that they are in sync
    between sources, and also for oversampling for the peak meter.
@@ -72,6 +72,11 @@ with:
     libavcodec-dev libavformat-dev libswscale-dev libavresample-dev \
     libmovit-dev libegl1-mesa-dev libasound2-dev libx264-dev
 
+Exceptions as of May 2016:
+
+  - You want kernel 4.6.0 or newer to get any use of the patches in
+    patches/ for persistent USB memory (see next paragraph).
+
 
 The patches/ directory contains some patches for upstream software that help
 Nageru performance and/or stability. They are all meant for upstream, but
@@ -105,8 +110,16 @@ The stream saved to disk will still be the Quick Sync-encoded stream, as it is
 typically higher bitrate and thus also higher quality. Note that if you add
 ".metacube" at the end of the URL (e.g. "http://127.0.0.1:9095/stream.ts.metacube"),
 you will get a stream suitable for streaming through the Cubemap video reflector
-(cubemap.sesse.net). See --help for more information on options in general.
+(cubemap.sesse.net). A typical example would be:
+
+  ./nageru --http-x264-video --x264-preset veryfast --x264-tune film \
+      --http-mux mp4 --http-audio-codec libfdk_aac --http-audio-bitrate 128
+
+If you are comfortable with using all your remaining CPU power on the machine
+for x264, try --x264-speedcontrol, which will try to adjust the preset
+dynamically for maximum quality, at the expense of somewhat higher delay.
 
+See --help for more information on options in general.
 
 The name “Nageru” is a play on the Japanese verb 投げる (nageru), which means
 to throw or cast. (I also later learned that it could mean to face defeat or