Update the README for CEF.

[nageru] / README

diff --git a/README b/README
index 01adb4e5be2562137cebd02eb18889567333f96a..8de4a84d7f5f239accd081a3dd1179b110d6c11f 100644 (file)
--- a/README
+++ b/README
@@ -8,7 +8,8 @@ Features:
 
  - High output quality; Lanczos3 scaling, subpixel precision everywhere,
    white balance adjustment, mix of 16- and 32-bit floating point
-   for intermediate calculations, dithered output.
+   for intermediate calculations, dithered output, optional 10-bit input
+   and output support.
 
  - Proper sound support: Syncing of multiple unrelated sources through
    high-quality resampling, multichannel mixing with separate effects
@@ -21,6 +22,11 @@ Features:
    pipelines, running transitions etc., so that the visual look is
    consistent between operators.
 
+ - HTML rendering (through Chromium Embedded Framework), for high-quality
+   and flexible overlay or other graphics.
+
+ - Comprehensive monitoring through Prometheus metrics.
+
 [1] For reference, that is: Core i7 4600U (dualcore 2.10GHz, clocks down
 to 800 MHz after 30 seconds due to thermal constraints), Intel HD Graphics
 4400 (ie., without the extra L4 cache from Iris Pro), single-channel DDR3 RAM
@@ -64,26 +70,38 @@ Nageru is in beta stage. It currently needs:
  - libzita-resampler, for resampling sound sources so that they are in sync
    between sources, and also for oversampling for the peak meter.
 
- - Lua, for driving the theme engine.
+ - LuaJIT, for driving the theme engine.
 
  - libpci, for printing friendly PCI device names in an error message.
 
+ - Optional: CEF (Chromium Embedded Framework), for HTML graphics.
+   If you build without CEF, the HTMLInput class will not be available from
+   the theme. You can get binary downloads of CEF from
+
+     http://opensource.spotify.com/cefbuilds/index.html
+
+   Simply download the right build for your platform (the “minimal” build
+   is fine) and add CEF_DIR=<path>/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64
+   on the make command line (substituting X with the real version as required).
+
 
 If on Debian stretch or something similar, you can install everything you need
 with:
 
   apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-dev \
-    pkg-config libmicrohttpd-dev libusb-1.0-0-dev liblua5.2-dev \
+    pkg-config libmicrohttpd-dev libusb-1.0-0-dev libluajit-5.1-dev \
     libzita-resampler-dev libva-dev libavcodec-dev libavformat-dev \
     libswscale-dev libavresample-dev libmovit-dev libegl1-mesa-dev \
     libasound2-dev libx264-dev libbmusb-dev protobuf-compiler \
     libprotobuf-dev libpci-dev
 
-Exceptions as of July 2017:
+Exceptions as of February 2018:
+
+  - You will need Movit from unstable; stretch only has 1.4.0.
 
-  - You will need Movit from git; stretch only has 1.4.0.
+  - You will need bmusb from unstable; stretch only has 0.5.4.
 
-  - You will need bmusb from experimental; stretch only has 0.5.4.
+  - Debian does not carry CEF (but it is optional).
 
 The patches/ directory contains a patch that helps zita-resampler performance.
 It is meant for upstream, but was not in at the time Nageru was released.